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:

Raw
graphql
query {
  fleetInstallationToken(id: "oLRBSVyNRmvrqgRGHw4WzMvjuyJSrYAq")
    {name, token, 
     installationCommands{linuxCommand},
     assignedConfiguration {id, name, modifiedAt}
    }
}
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 {
  fleetInstallationToken(id: \"oLRBSVyNRmvrqgRGHw4WzMvjuyJSrYAq\")
    {name, token, 
     installationCommands{linuxCommand},
     assignedConfiguration {id, name, modifiedAt}
    }
}"
}
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 {
  fleetInstallationToken(id: \"oLRBSVyNRmvrqgRGHw4WzMvjuyJSrYAq\")
    {name, token, 
     installationCommands{linuxCommand},
     assignedConfiguration {id, name, modifiedAt}
    }
}"
}
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 { ^
  fleetInstallationToken(id: \"oLRBSVyNRmvrqgRGHw4WzMvjuyJSrYAq\") ^
    {name, token,  ^
     installationCommands{linuxCommand}, ^
     assignedConfiguration {id, name, modifiedAt} ^
    } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  fleetInstallationToken(id: \"oLRBSVyNRmvrqgRGHw4WzMvjuyJSrYAq\")
    {name, token, 
     installationCommands{linuxCommand},
     assignedConfiguration {id, name, modifiedAt}
    }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "query {
  fleetInstallationToken(id: \"oLRBSVyNRmvrqgRGHw4WzMvjuyJSrYAq\")
    {name, token, 
     installationCommands{linuxCommand},
     assignedConfiguration {id, name, modifiedAt}
    }
}"
}';
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 {
  fleetInstallationToken(id: \"oLRBSVyNRmvrqgRGHw4WzMvjuyJSrYAq\")
    {name, token, 
     installationCommands{linuxCommand},
     assignedConfiguration {id, name, modifiedAt}
    }
}"
}'''

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 {
  fleetInstallationToken(id: \"oLRBSVyNRmvrqgRGHw4WzMvjuyJSrYAq\")
    {name, token, 
     installationCommands{linuxCommand},
     assignedConfiguration {id, name, modifiedAt}
    }
}"
}
);


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

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

ParameterTypeRequiredDefaultDescription
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  The assigned configuration. See LogCollectorConfiguration.
installationCommandsLogCollectorInstallCommandyes The installation commands. See LogCollectorInstallCommand.
namestringyes The name of the Fleet installation token.
tokenstringyes The Fleet installation token used.