🎯API Stability
Short-TermThis API may change in future versions. Use with caution in production environments.

Summary

The updateFleetInstallTokenConfigId() mutation associates a Fleet installation token with a specific configuration by its identifier. Call this mutation after creating or editing a configuration to assign it to an existing token. To rename a token instead, call updateFleetInstallTokenName().

Syntax

graphql
updateFleetInstallTokenConfigId(
      token: String!, configId: String
   ): FleetInstallationToken!

Provide the Fleet installation token string in token (required) and the configuration identifier in configId (optional). Omit configId to remove the current configuration association from the token. Query fleetInstallationTokens() to retrieve the configuration identifier before calling this mutation. The mutation always returns a non-null FleetInstallationToken! object.

Input parameters

Provide the Fleet installation token string and the configuration identifier to assign. Query fleetInstallationTokens() to retrieve the configuration identifier.

Table: Input parameters and 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 to assign to the token. Omit this argument to remove the current configuration association from the token.
token String! yes   The Fleet installation token string to update. Retrieve existing token values from the fleetInstallationTokens() query.

Example

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

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 {
  updateFleetInstallTokenConfigId( 
       configId: \"abc123\",
       token: \"abc123-def456-ghi789\"
  )
  { name }
}"
}
);


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": {
    "updateFleetInstallTokenConfigId": {
      "name": "my-token"
    }
  }
}

Returned values

The mutation returns the updated FleetInstallationToken! object, including the token value, its assigned configuration identifier, and the commands required to install the Falcon LogScale Collector. The return type is non-null.

Table: FleetInstallationToken Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
assignedConfigurationLogCollectorConfiguration  Short-Term The assigned configuration. See LogCollectorConfiguration.
expiresAtLong  Short-Term Stability: Short-term
installationCommandsLogCollectorInstallCommandyes Short-Term The installation commands. See LogCollectorInstallCommand.
jwtTokenStringyes Short-Term The JSON web token used.
nameStringyes Short-Term The name of the Fleet installation token.
tokenStringyes Short-Term The Fleet installation token used.