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

Summary

The stopLogCollectorConfigurationTest() mutation stops an active configuration test for a Log Collector configuration. Use this mutation to terminate a test that is currently running. The mutation returns a FleetConfigurationTest object containing the configuration ID and the IDs of the Log Collectors that were under test. To check whether a test is running before you stop it, use the searchLogCollectorConfigurations() query and inspect the isTestRunning field.

Syntax

graphql
stopLogCollectorConfigurationTest(
      configId: String!
   ): FleetConfigurationTest!

This mutation requires one argument: configId, the unique identifier of the Log Collector configuration whose active test to stop. The mutation returns a non-null FleetConfigurationTest! object. To find the configuration ID, use the searchLogCollectorConfigurations() query as shown in the Related section above.

Example

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

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 {
  stopLogCollectorConfigurationTest(
      configId: \"abc123\"
  )
  { configId }
}"
}
);


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": {
    "stopLogCollectorConfigurationTest": {
      "configId": "abc123"
    }
  }
}

Input Parameters

This mutation requires one input parameter: configId. To find the configuration ID, use the searchLogCollectorConfigurations() query and inspect the id field in the results.

Table: Input Parameters and Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
configId String yes   The unique identifier of the Log Collector configuration whose active test to stop.

Returned Values

The mutation returns a FleetConfigurationTest! object representing the stopped test. The object includes the configuration ID and the IDs of the Log Collectors that were under test. The following table lists the available fields:

Table: FleetConfigurationTest Datatype

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