API Stability Long-Term

The unenrollLogCollectors() GraphQL mutation unenrolls or disables a log collector from Fleet Management.

Syntax

Below is the syntax for the unassignTasks() mutation field:

graphql
unenrollLogCollectors(
      ids: [string]
   ): [EnrolledCollector]!

There are no special input datatypes for this mutation field. For the ids, enter within brackets the unique identifiers of the Log Collectors to disable in a comma-separated list.

Example

To unenroll a particular Log Collector, enter something like the following:

Raw
graphql
mutation{
  unenrollLogCollectors(
    ids: "f7be-46e6-8b16-146fed05f7ce"
  ) 
  { id }
}
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{
  unenrollLogCollectors(
    ids: \"f7be-46e6-8b16-146fed05f7ce\"
  ) 
  { id }
}"
}
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{
  unenrollLogCollectors(
    ids: \"f7be-46e6-8b16-146fed05f7ce\"
  ) 
  { id }
}"
}
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{ ^
  unenrollLogCollectors( ^
    ids: \"f7be-46e6-8b16-146fed05f7ce\" ^
  )  ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation{
  unenrollLogCollectors(
    ids: \"f7be-46e6-8b16-146fed05f7ce\"
  ) 
  { id }
}"
}'
    "$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{
  unenrollLogCollectors(
    ids: \"f7be-46e6-8b16-146fed05f7ce\"
  ) 
  { id }
}";
$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{
  unenrollLogCollectors(
    ids: \"f7be-46e6-8b16-146fed05f7ce\"
  ) 
  { id }
}"
}'''

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{
  unenrollLogCollectors(
    ids: \"f7be-46e6-8b16-146fed05f7ce\"
  ) 
  { id }
}"
}
);


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
Instance does not exist (HTTP Response Code 200 OK)
json
{
   "data" : null,
   "errors" : [
      {
         "errorCode" : "InstanceDoesNotExist",
         "isHumioUpdating" : false,
         "locations" : [
            {
               "column" : 11,
               "line" : 1
            }
         ],
         "message" : "Instance \"f7be-46e6-8b16-146fed05f7ce\" does not exist.",
         "path" : [
            "unenrollLogCollectors"
         ]
      }
   ],
   "extensions" : {
      "preview" : [
         {
            "name" : "unenrollLogCollectors",
            "reason" : "[PREVIEW: Under development]"
         }
      ]
   }
}
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "results": [
      "id": "f7be-46e6-8b16-146fed05f7ce"
    ]
  }
}

To use, first obtain the machine ID of each log collector. Use the searchFleet() query to get a list of machine IDs.

Returned Datatype

The returned datatype EnrolledCollector has a few of its own parameters. Below is a list of them:

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.