The rotateToken() GraphQL mutation may be used to rotate a token in LogScale.

Related to this mutation field are the deleteToken() and deleteReadonlyToken() for deleting tokens. There are also the createPersonalUserTokenV2(), createReadonlyToken(), createSystemPermissionsTokenV2(), and createViewPermissionsTokenV2() for creating tokens.

You may find useful the queries, token() to get information on a token, and tokens() for getting a list of tokens, and validateToken() for validating a token.

For more information on access tokens of various types, see the Ingest Tokens documentation page.

API Stability Long-Term

Syntax

graphql
rotateToken(
     input: RotateTokenInputData!
   ): string

For the input, you'll have to give the unique identifier of the token. You can use the tokens() query to get that. See the Given Datatype section for details on the input parameters.

For the results, a newly generated token is returned.

Example

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

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 {
  rotateToken( input:
     { id: \"abc123\" }
  )
}"
}
);


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" : {
    "rotateToken" : "def456ghi789"
  }
}

Given Datatype

For this input datatype, you'll have to give the unique identifier of the token. It's explained in the table here:

Table: RotateTokenInputData

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 19, 2024
idstringyes Long-TermThe unique identifier of the token to rotate.