Summary

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

API Stability Short-Term

Syntax

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

For the input, you would say how to sort and order the results, and the number of results to skip and how many to return. See the Input Parameters section for more details.

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 Values section.

Example

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": "abc123-def456-ghi789"
        }
      ]
    }
  }
}

Input Parameters

For the input, you would specify how to sort results (see the second table below), how to order results (see third), and the number of results to skip and how many to return.

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this query. Since some of the parameters use special datatypes, additional tables for them are included below.
limit integer   50 The maximum number of results to return.
orderBy OrderBy   ASc How to order the results. See table below.
skip integer   0 The number of results to skip, or offset to use.
sortBy FleetInstallationTokens__SortBy   Name How to sort results. See table below.

For this special input datatype, you can specify how to sort Fleet installation tokens.

Table: FleetInstallationTokens__SortBy Enum 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: 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 Enum 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: 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 Values

For the results, you can get the total results found, the installation token, the commands required to install, and the LogCollector's configuration.

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

The datatype above uses another datatype for information on Fleet installation tokens. For your convenience, the table for that sub-datatype is included here:

Table: FleetInstallationToken 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: Jul 24, 2025
assignedConfigurationLogCollectorConfiguration  Short-TermThe assigned configuration. See LogCollectorConfiguration.
installationCommandsLogCollectorInstallCommandyes Short-TermThe installation commands. See LogCollectorInstallCommand.
jwtTokenstringyes Short-TermThe JSON web token used.
namestringyes Short-TermThe name of the Fleet installation token.
tokenstringyes Short-TermThe Fleet installation token used.