🎯API Stability
Short-TermThis API may change in future versions. Use with caution in production environments.

Summary

The assignLogCollectorConfiguration() mutation assigns a single Log Collector to a specified configuration. Use this mutation to link one Log Collector to a configuration by its ID. To assign multiple Log Collectors to one configuration in a single call, use assignLogCollectorsToConfiguration().

Syntax

graphql
assignLogCollectorConfiguration(
      configId: String, id: String!
   ): Boolean!

The required id argument identifies the Log Collector to assign. The optional configId argument identifies the target configuration. The mutation returns a non-null Boolean indicating whether the assignment succeeded.

Example

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

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 {
  assignLogCollectorConfiguration(
     configId: \"abc123\", 
     id: \"def456\" )
}"
}
);


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": {
    "assignLogCollectorConfiguration": true
  }
}

Input Parameters

Provide the unique identifier of the Log Collector to assign. You may also provide the identifier of the target configuration.

Table: Input Parameters and Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
id string yes   The unique identifier of the Log Collector to assign.
configId string     The unique identifier of the configuration to assign to the Log Collector. Omit this argument to clear any existing configuration assignment, leaving the Log Collector unassigned.

Returned Values

The mutation returns a non-null Boolean!. A value of true indicates the assignment succeeded. A value of false indicates the Log Collector or configuration was not found, or the assignment did not complete.