API Stability Long-Term

The createViewPermissionsTokenV2() GraphQL mutation field is used to create a view permissions token with the specified permissions on the views specified in the viewIds field.

To change the permissions related to a view permissions token, use the updateViewPermissionsTokenPermissions() mutation. To delete a token, use the deleteToken() mutation.

Hide Query Example

Show View Permissions Query

For more information on access tokens of various types, see the Ingest Tokens documentation page. For information on user authorization, see the Manage Users and Permissions documentation page. You may also want to look at the Creating a Repository or View page for related information.

Syntax

graphql
createViewPermissionsTokenV2(
       input: CreateViewPermissionsTokenV2Input!
    ): CreateViewPermissionsTokenV2Output!

Example

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

Raw
graphql
mutation {
  createViewPermissionsTokenV2(input:
       { name: "my-view-token", 
         viewIds: [ "aK9GKAsTnMXfRxT8Fpecx3fX", "aK9GKAsTnMXfRxT8Fpecx3fX" ],
         viewPermissions: [ ReadAccess ]
       } )
  { token, tokenMetadata { name, expireAt } }
}
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 {
  createViewPermissionsTokenV2(input:
       { name: \"my-view-token\", 
         viewIds: [ \"aK9GKAsTnMXfRxT8Fpecx3fX\", \"aK9GKAsTnMXfRxT8Fpecx3fX\" ],
         viewPermissions: [ ReadAccess ]
       } )
  { token, tokenMetadata { name, expireAt } }
}"
}
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 {
  createViewPermissionsTokenV2(input:
       { name: \"my-view-token\", 
         viewIds: [ \"aK9GKAsTnMXfRxT8Fpecx3fX\", \"aK9GKAsTnMXfRxT8Fpecx3fX\" ],
         viewPermissions: [ ReadAccess ]
       } )
  { token, tokenMetadata { name, expireAt } }
}"
}
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 { ^
  createViewPermissionsTokenV2(input: ^
       { name: \"my-view-token\",  ^
         viewIds: [ \"aK9GKAsTnMXfRxT8Fpecx3fX\", \"aK9GKAsTnMXfRxT8Fpecx3fX\" ], ^
         viewPermissions: [ ReadAccess ] ^
       } ) ^
  { token, tokenMetadata { name, expireAt } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createViewPermissionsTokenV2(input:
       { name: \"my-view-token\", 
         viewIds: [ \"aK9GKAsTnMXfRxT8Fpecx3fX\", \"aK9GKAsTnMXfRxT8Fpecx3fX\" ],
         viewPermissions: [ ReadAccess ]
       } )
  { token, tokenMetadata { name, expireAt } }
}"
}'
    "$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 {
  createViewPermissionsTokenV2(input:
       { name: \"my-view-token\", 
         viewIds: [ \"aK9GKAsTnMXfRxT8Fpecx3fX\", \"aK9GKAsTnMXfRxT8Fpecx3fX\" ],
         viewPermissions: [ ReadAccess ]
       } )
  { token, tokenMetadata { name, expireAt } }
}";
$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 {
  createViewPermissionsTokenV2(input:
       { name: \"my-view-token\", 
         viewIds: [ \"aK9GKAsTnMXfRxT8Fpecx3fX\", \"aK9GKAsTnMXfRxT8Fpecx3fX\" ],
         viewPermissions: [ ReadAccess ]
       } )
  { token, tokenMetadata { name, expireAt } }
}"
}'''

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 {
  createViewPermissionsTokenV2(input:
       { name: \"my-view-token\", 
         viewIds: [ \"aK9GKAsTnMXfRxT8Fpecx3fX\", \"aK9GKAsTnMXfRxT8Fpecx3fX\" ],
         viewPermissions: [ ReadAccess ]
       } )
  { token, tokenMetadata { name, expireAt } }
}"
}
);


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": {
    "createViewPermissionsTokenV2": {
      "token": "aF0u1YdgSGwWTxC8FlYURIsNI...",
      "tokenMetadata": {
        "name": "my-view-token",
        "expireAt": null
      }
    }
  }
}

Given Datatype

For this input datatype, you would provide the name of the token, a list of unique identifiers for the views, and a list of permissions. These are listed and explained, along with other parameters, in the table below:

Table: CreateViewPermissionsTokenV2Input

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: May 6, 2025
assetPermissionAssignments[ViewPermissionsTokenAssetPermissionAssignmentInput]yes Long-TermThe asset permission assignments for the view token. See ViewPermissionsTokenAssetPermissionAssignmentInput.
expireAtlong  Long-TermThe date the token expires.
ipFilterIdstring  Long-TermThe unique identifier for the IP filter.
namestringyes Long-TermThe name of the permissions token.
viewIds[string]yes Long-TermThe unique identifiers for the views.
viewPermissions[Permission]yes Long-TermA list of permissions for the token. See Permission.

Returned Datatype

With this returned datatype, through sub-parameters, you can get a list of permissions and views associated with the token. The table below contains some details, and links to these sub-parameters:

Table: CreateViewPermissionsTokenV2Output

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: Dec 10, 2024
tokenstringyes Long-TermThe token returned.
tokenMetadataViewPermissionsTokenyes Long-TermThe meta data related to the token. See ViewPermissionsToken.