Summary

The stopLogCollectorConfigurationTest() GraphQL mutation may be used to stop a configuration test in a Log Collector.

API Stability Short-Term

Syntax

graphql
stopLogCollectorConfigurationTest(
      configId: string!
   ): FleetConfigurationTest!

For this mutation, you'll have to give the unique identifier of the LogCollector configuration you want to stop testing. Click on the Show Query link above for an example of how to get the identifier.

For the results, you can get a list of LogCollector identifiers in case you want to start some or stop others. Below is a list of the choices to get this information:

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

For the input, you'll have to give the unique identifier of the LogCollector configuration you want to stop testing. Click on the Show Query link above the Syntax section for an example of how to get the identifier.

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
configId string yes   The unique identifier of the LogCollector configuration.

Returned Values

For the results, you can get a list of LogCollector identifiers in case you want to start some or stop others. Below is a list of the choices to get this information:

Table: FleetConfigurationTest Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 25, 2024
configIdstringyes Short-TermThe configuration identifier.
collectorIds[string]yes Short-TermThe Log Collector unique identifiers.