The createReadonlyToken() GraphQL mutation may be used to create a new sharable link to a LogScale dashboard.

For more information on access tokens of various types, see the Ingest Tokens documentation page. For information on user authorization, see the Manage users & permissions documentation page.

Syntax

Below is the syntax for the createReadonlyToken() mutation field:

graphql
createReadonlyToken(
      id: string!
      name: string!
      ipFilterId: string,
      queryOwnershipType: QueryOwnershipType
   ): DashboardLink!

For the id, the unique identifier of the dashboard should be given. Below is an example of how this mutation field might be used:

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

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 {
  createReadonlyToken(
        id: \"X3ax4M65ZyyRRd12MytBLifzoCmT5cK0\",
        name: \"reader-token\",
        queryOwnershipType: Organization
      )
  { token }
}"
}
);


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();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "createReadonlyToken": {
      "token": "Srme9n2tb1Sko6tilBO8JWAH"
    }
  }
}

The queryOwnershipType is for giving the ownership of the queries run by this shared dashboard. If value is User, ownership wil be based the calling user.

Returned Datatypes

The returned datatype DashboardLink has a few parameters. Below is a list of them: