Summary

The createFleetInstallToken() GraphQL mutation may be used to create a fleet installation token.

API Stability Long-Term

Syntax

graphql
createFleetInstallToken(
      name: string!,
      configId: string,
      expiresAt: long
   ): FleetInstallationToken!

For the input, you'll have to give a name for the Fleet install token. You may also give the date in which it will expire. See the Input Parameters section for more.

For the results, you can get the installation token, the commands required to install, and other values. See the Returned Values section for details.

Example

Raw
graphql
mutation {
  createFleetInstallToken(
        name: "my-token",
        configId: "123456")
  { token, jwtToken }
}
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 {
  createFleetInstallToken(
        name: \"my-token\",
        configId: \"123456\")
  { token, jwtToken }
}"
}
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 {
  createFleetInstallToken(
        name: \"my-token\",
        configId: \"123456\")
  { token, jwtToken }
}"
}
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 { ^
  createFleetInstallToken( ^
        name: \"my-token\", ^
        configId: \"123456\") ^
  { token, jwtToken } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createFleetInstallToken(
        name: \"my-token\",
        configId: \"123456\")
  { token, jwtToken }
}"
}'
    "$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 {
  createFleetInstallToken(
        name: \"my-token\",
        configId: \"123456\")
  { token, jwtToken }
}";
$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 {
  createFleetInstallToken(
        name: \"my-token\",
        configId: \"123456\")
  { token, jwtToken }
}"
}'''

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 {
  createFleetInstallToken(
        name: \"my-token\",
        configId: \"123456\")
  { token, jwtToken }
}"
}
);


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();

Input Parameters

For the input, you'll have to give a name for the Fleet install token. You may also give the date in which it will expire. The table here describes these parameters:

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
configId string     The unique identifier of the Fleet installation configuration.
expiresAt string     When the token expires.
name string yes   The name of the installation token.

Returned Values

For the results, you can get the installation token, the commands required to install, and other values. You can drill down to get more details, like the LogCollector's configuration. To see these choices, you'll have to click on the links below to the relevant tables.

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.