๐ŸŽฏAPI Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The updateFleetInstallTokenName() mutation renames a Fleet installation token. Provide the current token value and the new display name to assign. Renaming a token does not modify its configuration or invalidate its value.

Syntax

graphql
updateFleetInstallTokenName(
      token: String!, name: String!
   ): FleetInstallationToken!

The token argument is required and identifies the installation token to rename. The name argument is required and sets the new display name for the token.

The mutation returns a FleetInstallationToken! object. Request the name and token fields to confirm the update.

Input parameters

Provide the token value to identify the target installation token and the new name to assign to it.

Table: Input parameters and datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
token String! yes ย  The Fleet installation token value that identifies the token to rename. This is the token string, not the token's current name.
name String! yes ย  The new display name to assign to the installation token. This value replaces the token's current name in Fleet management.

Example

Raw
graphql
mutation {
  updateFleetInstallTokenName( 
       name: "my-token",
       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 {
  updateFleetInstallTokenName( 
       name: \"my-token\",
       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 {
  updateFleetInstallTokenName( 
       name: \"my-token\",
       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 { ^
  updateFleetInstallTokenName(  ^
       name: \"my-token\", ^
       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 {
  updateFleetInstallTokenName( 
       name: \"my-token\",
       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 {
  updateFleetInstallTokenName( 
       name: \"my-token\",
       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 {
  updateFleetInstallTokenName( 
       name: \"my-token\",
       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 {
  updateFleetInstallTokenName( 
       name: \"my-token\",
       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": {
    "updateFleetInstallTokenName": {
      "name": "my-token"
    }
  }
}

Returned values

The mutation returns a FleetInstallationToken! object reflecting the token's state after the rename. The object includes the updated name, the token value, and any associated LogCollector configuration.