API Stability Long-Term

The fleetInstallationToken() GraphQL query is used to get the Fleet installation token.

Syntax

Below is the syntax for the fleetInstallationToken() query field:

graphql
fleetInstallationToken(
     id: string!
   ): FleetInstallationToken!

The fleetInstallationToken return datatype is used to return information about the installation token. The parameters it allows is covered in a table in the Return Datatype section further down this page. Below is an example of how you might use this query field and list return parameters:

Show:
graphql
query {
  fleetInstallationToken(id: "oLRBSVyNRmvrqgRGHw4WzMvjuyJSrYAq")
    {name, token, 
     installationCommands{linuxCommand},
     assignedConfiguration {id, name, modifiedAt}
    }
}

Returned Datatypes

The FleetInstallationToken datatype has a few parameters, a couple with special datatypes of their own. Below is a list of them:

Table: FleetInstallationToken

ParameterTypeRequiredDefaultStabilityDescription
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 25, 2024
assignedConfigurationLogCollectorConfiguration  Short-TermThe assigned configuration. See LogCollectorConfiguration.
installationCommandsLogCollectorInstallCommandyes Short-TermThe installation commands. See LogCollectorInstallCommand.
namestringyes Short-TermThe name of the Fleet installation token.
tokenstringyes Short-TermThe Fleet installation token used.