The assignLogCollectorsToConfiguration() GraphQL mutation is used to assign Log Collectors to a particular configuration. To assign only one Log Collector, you can use assignLogCollectorConfiguration().

To create a Log Collector configuration, use the createLogCollectorConfiguration() mutation. To update a configuration, you can use publishLogCollectorConfiguration(). To delete one, use deleteLogCollectorConfiguration(). To get the Log Collector's details, there's the getLogCollectorDetails() query.

API Stability Short-Term

Syntax

graphql
assignLogCollectorsToConfiguration(
      configId: string,
      ids: [string])
   ): [EnrolledCollector]!

For the input, you would provide the unique identifier of the configuration and a comma-separated list of identifiers of the Log Collectors. The results returned are the mostly the same parameters. See the Returned Datatype section farther down this page.

Example

Raw
graphql
mutation {
  assignLogCollectorsToConfiguration(
     configId: "abc123", 
     ids: ["def456". "ghi789"] )
  { id, configId, machineId }
}
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 {
  assignLogCollectorsToConfiguration(
     configId: \"abc123\", 
     ids: [\"def456\". \"ghi789\"] )
  { id, configId, machineId }
}"
}
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 {
  assignLogCollectorsToConfiguration(
     configId: \"abc123\", 
     ids: [\"def456\". \"ghi789\"] )
  { id, configId, machineId }
}"
}
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 { ^
  assignLogCollectorsToConfiguration( ^
     configId: \"abc123\",  ^
     ids: [\"def456\". \"ghi789\"] ) ^
  { id, configId, machineId } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  assignLogCollectorsToConfiguration(
     configId: \"abc123\", 
     ids: [\"def456\". \"ghi789\"] )
  { id, configId, machineId }
}"
}'
    "$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 {
  assignLogCollectorsToConfiguration(
     configId: \"abc123\", 
     ids: [\"def456\". \"ghi789\"] )
  { id, configId, machineId }
}";
$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 {
  assignLogCollectorsToConfiguration(
     configId: \"abc123\", 
     ids: [\"def456\". \"ghi789\"] )
  { id, configId, machineId }
}"
}'''

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 {
  assignLogCollectorsToConfiguration(
     configId: \"abc123\", 
     ids: [\"def456\". \"ghi789\"] )
  { id, configId, machineId }
}"
}
);


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

Given Datatype

For the input, you would provide the unique identifier of the configuration, and a comma-separated list of identifiers of the Log Collectors.

Table: Input Using Standard Datatypes

Parameter Type Required Default Description
configId string     The unique identifier of the configuration.
collectorIds [string]     A comma-separated list of identifiers of the Log Collectors.

Returned Datatype

The returned datatype provides parameters for getting information about an enrolled collector These are described here:

Table: EnrolledCollector

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 24, 2024
configIdstring  Short-TermThe unique identifier for the configuration used.
idstringyes Short-TermThe unique identifier for the enrolled LogCollector.
machineIdstringyes Short-TermThe unique machine identifier.