Summary

The publishLogCollectorConfiguration() GraphQL mutation is used to update a Log Collector configuration.

API Stability Short-Term

Syntax

graphql
publishLogCollectorConfiguration(
       id: string!, 
       yaml: string, 
       currentVersion: integer!
    ): LogCollectorConfiguration!

You'll have to give the unique identifier of the LogCollector configuration, and the current version number. You'd give the updated configuration in yaml format.

For the results, you can get the details of the LogCollector configuration, which you probably already know since you will have just reconfigured it with this mutation. See the Returned Values section for your choices.

Example

Raw
graphql
mutation {
  publishLogCollectorConfiguration( 
      id: "12345",
      currentVersion: 1
  )
  { name, modifiedAt }
}
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 {
  publishLogCollectorConfiguration( 
      id: \"12345\",
      currentVersion: 1
  )
  { name, modifiedAt }
}"
}
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 {
  publishLogCollectorConfiguration( 
      id: \"12345\",
      currentVersion: 1
  )
  { name, modifiedAt }
}"
}
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 { ^
  publishLogCollectorConfiguration(  ^
      id: \"12345\", ^
      currentVersion: 1 ^
  ) ^
  { name, modifiedAt } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  publishLogCollectorConfiguration( 
      id: \"12345\",
      currentVersion: 1
  )
  { name, modifiedAt }
}"
}'
    "$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 {
  publishLogCollectorConfiguration( 
      id: \"12345\",
      currentVersion: 1
  )
  { name, modifiedAt }
}";
$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 {
  publishLogCollectorConfiguration( 
      id: \"12345\",
      currentVersion: 1
  )
  { name, modifiedAt }
}"
}'''

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 {
  publishLogCollectorConfiguration( 
      id: \"12345\",
      currentVersion: 1
  )
  { name, modifiedAt }
}"
}
);


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": {
    "publishLogCollectorConfiguration": {
      "name": "abc123",
      "modifiedAt": "2025-12-18T20:39:35"
    }
  }
}

Input Parameters

For the input, you would provide the unique identifier of the LogCollector configuration, and the current version number. You'd give the updated configuration in yaml format.

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
currentVersion integer yes   The current version number.
id string yes   The unique identifier of the LogCollector configuration.
yaml string yes   The LogCollector configuration in yaml format.

Returned Values

You can get a yaml configuration for LogCollector, the user who last modified it and when, what version of LogCollector is running and other such data. The table below lists what's available:

Table: LogCollectorConfiguration Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for 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.