API Stability Long-Term

The createSystemPermissionsTokenV2() GraphQL mutation is used to create a system permissions token with the specified permissions.

Syntax

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

graphql
createSystemPermissionsTokenV2(
       input: CreateSystemPermissionTokenV2Input!
    ): CreateSystemPermissionsTokenV2Output!

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
	createSystemPermissionsTokenV2( input:
	  { name: "my-token",
      systemPermissions: [ ViewOrganizations,
                           ManageOrganizations ]
    } )
  { token, tokenMetadata { 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 {
	createSystemPermissionsTokenV2( input:
	  { name: \"my-token\",
      systemPermissions: [ ViewOrganizations,
                           ManageOrganizations ]
    } )
  { token, tokenMetadata { 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 {
	createSystemPermissionsTokenV2( input:
	  { name: \"my-token\",
      systemPermissions: [ ViewOrganizations,
                           ManageOrganizations ]
    } )
  { token, tokenMetadata { 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 { ^
	createSystemPermissionsTokenV2( input: ^
	  { name: \"my-token\", ^
      systemPermissions: [ ViewOrganizations, ^
                           ManageOrganizations ] ^
    } ) ^
  { token, tokenMetadata { name } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
	createSystemPermissionsTokenV2( input:
	  { name: \"my-token\",
      systemPermissions: [ ViewOrganizations,
                           ManageOrganizations ]
    } )
  { token, tokenMetadata { 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 {
	createSystemPermissionsTokenV2( input:
	  { name: \"my-token\",
      systemPermissions: [ ViewOrganizations,
                           ManageOrganizations ]
    } )
  { token, tokenMetadata { 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 {
	createSystemPermissionsTokenV2( input:
	  { name: \"my-token\",
      systemPermissions: [ ViewOrganizations,
                           ManageOrganizations ]
    } )
  { token, tokenMetadata { 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 {
	createSystemPermissionsTokenV2( input:
	  { name: \"my-token\",
      systemPermissions: [ ViewOrganizations,
                           ManageOrganizations ]
    } )
  { token, tokenMetadata { 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": {
    "createSystemPermissionsTokenV2": {
      "token": "abc123",
      "tokenMetadata": {
        "name": "my-token"
      }
    }
  }
}

Given Datatypes

For CreateSystemPermissionTokenV2Input, there are a few parameters that may be given. Below is a list of them along with a description of each:

Table: CreateSystemPermissionTokenV2Input

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: Feb 28, 2025
expireAtlong  Long-TermThe time at which the token expires.
ipFilterIdstring  Long-TermThe unique identifier of the IP filter.
namestringyes Long-TermThe name of the token.
systemPermissions[SystemPermission]yes Long-TermA list of system permissions. See SystemPermission.

Returned Data Types

CreateSystemPermissionsTokenV2Output returns a couple parameters. They're described below:

Table: CreateSystemPermissionsTokenV2Output

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: Feb 28, 2025
tokenstringyes Long-TermThe system permissions token.
tokenMetadataSystemPermissionsTokenyes Long-TermThe token's metadata. See SystemPermissionsToken.