API Stability Short-Term

The searchFleetInstallationTokens() GraphQL query will search for Fleet installation tokens.

Related to this query, there are also the queries, searchFleet() to get a list of Fleet configured hosts, getFleetManagementUrl() to get the URL endpoint for Fleet management, and fleetInstallationTokens() to get a list of Fleet installation tokens and related information.

Additionally, there are the createFleetInstallToken() and updateFleetInstallTokenConfigId() mutation fields for creating and updating Fleet installation tokens and configurations.

Syntax

graphql
searchFleetInstallationTokens(
      sortBy: FleetInstallationTokens__SortBy, 
      orderBy: OrderBy,
      skip: integer, 
      limit: integer
   ): SearchFleetInstallationTokenResultSet!

For the input, there are several parameters. Some have default values: skip is 0; and limit is 50. There are also defaults for the special datatypes. They're described in the Given Datatypes section below.

For the results, you can get the total results found, the installation token, the commands required to install, and the LogCollector's configuration. To see your choices, scroll down to the Returned Datatype section.

Example

Below is an example using this query field:

Raw
graphql
query {
  searchFleetInstallationTokens(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{name, token} }
}
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" : "query {
  searchFleetInstallationTokens(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{name, token} }
}"
}
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" : "query {
  searchFleetInstallationTokens(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{name, token} }
}"
}
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" : "query { ^
  searchFleetInstallationTokens(sortBy: Name, orderBy: ASC) ^
     { totalResults,  ^
       results{name, token} } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  searchFleetInstallationTokens(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{name, token} }
}"
}'
    "$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 = "query {
  searchFleetInstallationTokens(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{name, token} }
}";
$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" : "query {
  searchFleetInstallationTokens(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{name, token} }
}"
}'''

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" : "query {
  searchFleetInstallationTokens(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{name, token} }
}"
}
);


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": {
    "searchFleetInstallationTokens": {
      "totalResults": 1,
      "results": [
        {
          "name": "Nifty Install Token",
          "token": "yTscARmEpK7MWqcKuZZMI6kevsqPZeB9"
        }
      ]
    }
  }
}

Given Datatypes

There are a couple of given datatypes for this query. One allows you to sort by the token name or the configuration name. Your choices for this are listed in the table here:

Table: FleetInstallationTokens__SortBy

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: Oct 3, 2025
ConfigName   Short-TermThe name of the configuration.
Name  ✓Short-TermThe name of the Fleet installation token.

The other input datatype is a simple one. You can return results based on whether they are in ascending or descending order, alphanumerically.

Table: OrderBy

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: Oct 10, 2025
ASC  ✓Long-TermOrder results in ascending order (e.g., 0 to 9, A to Z).
DESC   Long-TermOrder results in descending order (e.g., 9 to 0, Z to A).

Returned Datatype

The returned datatype is used to get the total results found, and through a sub-parameter, you can get the installation token, the commands required to install, and other parameters. You can drill down to get more details, like LogCollector's configuration. To see these choices, you'll have to click on the link below to the table for the datatype it uses.

Table: SearchFleetInstallationTokenResultSet

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: Mar 19, 2025
results[FleetInstallationToken]yes Short-TermThe paginated result set. See FleetInstallationToken.
totalResultsintegeryes Short-TermThe total number of matching results.