API Stability Short-Term

The logCollectorConfiguration() GraphQL query returns the configuration for a Log Collector.

Syntax

Below is the syntax for the logCollectorConfiguration() query field:

graphql
logCollectorConfiguration(
     id: string!
   ): LogCollectorConfiguration!

For the input you would enter the unique identifier of the Log Collector within quotes. The returned datatype, LogCollectorConfiguration has a few parameters (see Returned Datatype section). Below is an example using this query field:

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

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" : "query {
  logCollectorConfiguration(id: \"12345\") 
  {id, name, modifiedAt, modifiedBy, yaml}
}"
}
);


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();

Returned Datatypes

LogCollectorConfiguration has a few 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.