API Stability Short-Term

The updateLogCollectorConfigurationDescription() GraphQL mutation is used to update Log Collector's configuration description.

Syntax

Below is the syntax for the updateLogCollectorConfigurationDescription() mutation field:

graphql
updateLogCollectorConfigurationDescription(
      configId: string!, 
      description: string
   ): LogCollectorConfiguration!

There are no special given datatypes for this mutation field. Below is an example of how it might be used:

Raw
graphql
mutation {
  updateLogCollectorConfigurationDescription( 
     configId: "abc123",
     description: "The Log Collector"
  )
 { name }
}
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 {
  updateLogCollectorConfigurationDescription( 
     configId: \"abc123\",
     description: \"The Log Collector\"
  )
 { name }
}"
}
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 {
  updateLogCollectorConfigurationDescription( 
     configId: \"abc123\",
     description: \"The Log Collector\"
  )
 { name }
}"
}
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 { ^
  updateLogCollectorConfigurationDescription(  ^
     configId: \"abc123\", ^
     description: \"The Log Collector\" ^
  ) ^
 { name } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateLogCollectorConfigurationDescription( 
     configId: \"abc123\",
     description: \"The Log Collector\"
  )
 { name }
}"
}'
    "$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 {
  updateLogCollectorConfigurationDescription( 
     configId: \"abc123\",
     description: \"The Log Collector\"
  )
 { name }
}";
$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 {
  updateLogCollectorConfigurationDescription( 
     configId: \"abc123\",
     description: \"The Log Collector\"
  )
 { name }
}"
}'''

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 {
  updateLogCollectorConfigurationDescription( 
     configId: \"abc123\",
     description: \"The Log Collector\"
  )
 { name }
}"
}
);


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": {
    "updateLogCollectorConfigurationDescription": {
      "name": "our-logcollector"
    }
  }
}

Returned Datatypes

For LogCollectorConfiguration, there are several parameters. Below is a list of them along with a description of each:

Table: LogCollectorConfiguration

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: Jun 26, 2025
descriptionstring  Short-TermA description of the Log Collector configuration.
draftstring  Short-TermThe configuration draft.
draftModifiedAtdatetime  Short-TermThe date and time of the last draft of the configuration.
idstringyes Short-TermThe unique identifier for the log collector configuration.
instancesintegeryes Short-TermThe number of instances.
isTestRunningbooleanyes Short-TermWhether a test is running.
modifiedAtdatetimeyes Short-TermThe date and time of the current configuration.
modifiedBystringyes Short-TermWho last modified the configuration.
namestringyes Short-TermThe name assigned to the log collector configuration.
versionintegeryes Short-TermThe version used.
yamlstring  Short-TermConfiguration in YAML format.
yamlCharactersCountintegeryes Short-TermThe yaml character count.