unenrollLogCollectors()

API Stability	`Long-Term`

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

graphql

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

Below is an example of how this mutation field might be used:

Show:

graphql

mutation{
  unenrollLogCollectors(
    ids: "f7be-46e6-8b16-146fed05f7ce"
  ) 
  { id }
}

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

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

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 } ^
}" ^
} '

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

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation{
  unenrollLogCollectors(
    ids: \"f7be-46e6-8b16-146fed05f7ce\"
  ) 
  { id }
}"
}';
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

#! /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)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation{
  unenrollLogCollectors(
    ids: \"f7be-46e6-8b16-146fed05f7ce\"
  ) 
  { id }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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

Show:

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]"
         }
      ]
   }
}

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

Parameter	Type	Required	Stability	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 24, 2024
`configId`	string		`Short-Term`	The unique identifier for the configuration used.
`id`	string	yes	`Short-Term`	The unique identifier for the enrolled LogCollector.
`machineId`	string	yes	`Short-Term`	The unique machine identifier.

Example

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

Show:

graphql

mutation{
  unenrollLogCollectors(
    ids: "f7be-46e6-8b16-146fed05f7ce"
  ) 
  { id }
}

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

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

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 } ^
}" ^
} '

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

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation{
  unenrollLogCollectors(
    ids: \"f7be-46e6-8b16-146fed05f7ce\"
  ) 
  { id }
}"
}';
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

#! /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)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation{
  unenrollLogCollectors(
    ids: \"f7be-46e6-8b16-146fed05f7ce\"
  ) 
  { id }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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

Show:

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]"
         }
      ]
   }
}

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes