Summary

The deleteReadonlyToken() GraphQL mutation may be used to remove a shared link to a dashboard.

API Stability Long-Term

Syntax

graphql
deleteReadonlyToken(
      id: string!,
      token: string!
   ): BooleanResultType!

For the input, you'll have to provide the unique identifier of the token, as well as the token itself, to delete. See the Input Parameters section.

For the results, you'll receive confirmation if successful. See the Returned Values section.

Example

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

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 {
  deleteReadonlyToken( 
        id: \"abc123\",
        token: \"def456\"
  )
  {result}
}"
}
);


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": {
    "deleteReadonlyToken": {
      "result": true
    }
  }
}

Input Parameters

For the input, you'll have to provide the unique identifier of the token, as well as the token itself, to delete.

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
id string yes   The identifier of the read-only token.
token string yes   The actual token to delete — for authenticating and ensuring the correct one is deleted.

Returned Values

For the results, the only value indicates whether the mutation was successful or not. The table below describes this:

Table: BooleanResultType Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 24, 2024
resultbooleanyes Long-TermWhether the mutation was performed successfully.