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

Summary

The removeFromLogCollectorConfigurationTest() mutation removes one or more Log Collectors from an active Fleet management configuration test. Use this mutation to reduce the scope of a running test without stopping it entirely. To stop the test completely, use stopLogCollectorConfigurationTest() instead.

Syntax

graphql
removeFromLogCollectorConfigurationTest(
      configId: String!,
      collectorIds: [String!]!
   ): FleetConfigurationTest!

Provide the unique identifier of the Fleet management configuration test in configId, and a non-empty list of Log Collector identifiers in collectorIds. Both arguments are required. The mutation returns a FleetConfigurationTest object that reflects the updated state of the test after the removal.

Example

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

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 {
  removeFromLogCollectorConfigurationTest(
      configId: \"abc123\",
      collectorIds: []
   )
  { configId, collectorIds }
}"
}
);


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": {
    "removeFromLogCollectorConfigurationTest": {
      "configId": "abc123",
      "collectorIds": []
    }
  }
}

Input Parameters

Both input parameters are required. Provide the configuration test identifier and the list of Log Collector identifiers to remove from that test.

Table: Input Parameters and Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
collectorIds [String!]! yes   The unique identifiers of the Log Collector configurations to remove from the test. Each element in the list must be a non-null string. The list itself must not be null.
configId String! yes   The unique identifier of the Fleet management configuration test from which to remove the specified Log Collectors.

Returned Values

The mutation returns a FleetConfigurationTest object representing the updated test state. The returned object includes the current list of Log Collector identifiers associated with the test, which you can use to verify the removal or plan further modifications.

Table: FleetConfigurationTest Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
collectorIdsStringyes Short-Term The Log Collector unique identifiers.
configIdStringyes Short-Term The configuration identifier.