API Stability Long-Term

The updateFdrFeedControl() GraphQL mutation may be used to update a FDR feed administrator control.

Similar to this mutation, there is also updateFdrFeed(). To add a new FDR feed, you would use the createFdrFeed() mutation. To test an FDR feed, you could use the testFdrFeed() mutation. To delete a feed, use the deleteFdrFeed() mutation.

Hide Query Example

Show FDR Feed Query

For more information on FDR ingest feeds, see Ingesting FDR Data into a Repository.

Syntax

graphql
updateFdrFeedControl(
      input: UpdateFdrFeedControl!
   ): FdrFeedControl!

Example

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  updateFdrFeedControl( input:
     { repositoryName: "humio",
       id: "abc123",
       maxNodes: { value: 3 }
     } 
  )
  { id }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateFdrFeedControl( input:
     { repositoryName: \"humio\",
       id: \"abc123\",
       maxNodes: { value: 3 }
     } 
  )
  { id }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateFdrFeedControl( input:
     { repositoryName: \"humio\",
       id: \"abc123\",
       maxNodes: { value: 3 }
     } 
  )
  { id }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  updateFdrFeedControl( input: ^
     { repositoryName: \"humio\", ^
       id: \"abc123\", ^
       maxNodes: { value: 3 } ^
     }  ^
  ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateFdrFeedControl( input:
     { repositoryName: \"humio\",
       id: \"abc123\",
       maxNodes: { value: 3 }
     } 
  )
  { id }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  updateFdrFeedControl( input:
     { repositoryName: \"humio\",
       id: \"abc123\",
       maxNodes: { value: 3 }
     } 
  )
  { id }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  updateFdrFeedControl( input:
     { repositoryName: \"humio\",
       id: \"abc123\",
       maxNodes: { value: 3 }
     } 
  )
  { id }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  updateFdrFeedControl( input:
     { repositoryName: \"humio\",
       id: \"abc123\",
       maxNodes: { value: 3 }
     } 
  )
  { id }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "updateFdrFeedControl": {
      "id": "abc123"
    }
  }
}

Given Datatype

For the input datatype, you'll have to give the name of the repository and the unique identifier of the FDR feed, along with the number of nodes to poll, and maximum files downloaded per node. The table below provides more details:

Table: UpdateFdrFeedControl

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 23, 2024
fileDownloadParallelismUpdateLong  Long-TermMaximum amount of files downloaded from s3 in parallel for a single node. To clear value, enter no value or a null. If parameter is not included, it won't be change. See UpdateLong.
idstringyes Long-TermThe unique identifier of the FDR feed.
maxNodesUpdateLongyes Long-TermMaximum number of nodes with which to poll FDR feed. To clear value, enter no value or a null. If parameter is not included, it won't be change. See UpdateLong.
repositoryNamestringyes Long-TermThe name of the repository of the FDR feed.

Returned Datatype

This datatype returns information on an FDR feed of interest to an administrator, such as the maximum number of nodes with which to poll the feed, and the maximum number of files downloaded in a single node. The table below has more details:

Table: FdrFeedControl

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 25, 2024
fileDownloadParallelisminteger  Long-TermThe maximum amount of files downloaded from s3 in parallel for a single node.
idstringyes Long-TermThe unique identifier of the FDR feed.
maxNodesinteger  Long-TermThe maximum number of nodes with which to poll the FDR feed.