Create API Token

Create API token

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

name

string

required

Name of the token

datasetCapabilities

object

Show child attributes

datasetCapabilities.{key}

object

Show child attributes

datasetCapabilities.{key}.ingest

enum<string>[]

Ingest capability

Available options:

create

datasetCapabilities.{key}.query

enum<string>[]

Query capability

Available options:

read

datasetCapabilities.{key}.starredQueries

enum<string>[]

Starred queries capability

Available options:

create,

read,

update,

delete

datasetCapabilities.{key}.virtualFields

enum<string>[]

Virtual fields capability

Available options:

create,

read,

update,

delete

description

string

Description of the token

expiresAt

string | null

Expiration date of the token (ISO 8601 format)

orgCapabilities

object

Show child attributes

orgCapabilities.annotations

enum<string>[]

Annotations capability

Available options:

create,

read,

update,

delete

orgCapabilities.apiTokens

enum<string>[]

API tokens capability

Available options:

create,

read,

update,

delete

orgCapabilities.billing

enum<string>[]

Billing capability

Available options:

read,

update

orgCapabilities.dashboards

enum<string>[]

Dashboards capability

Available options:

create,

read,

update,

delete

orgCapabilities.datasets

enum<string>[]

Datasets capability

Available options:

create,

read,

update,

delete

orgCapabilities.endpoints

enum<string>[]

Endpoints capability

Available options:

create,

read,

update,

delete

orgCapabilities.flows

enum<string>[]

Flows capability

Available options:

create,

read,

update,

delete

orgCapabilities.integrations

enum<string>[]

Integrations capability

Available options:

create,

read,

update,

delete

orgCapabilities.monitors

enum<string>[]

Monitors capability

Available options:

create,

read,

update,

delete

orgCapabilities.notifiers

enum<string>[]

Notifiers capability

Available options:

create,

read,

update,

delete

orgCapabilities.rbac

enum<string>[]

Access control capability

Available options:

create,

read,

update,

delete

orgCapabilities.sharedAccessKeys

enum<string>[]

Shared access keys capability

Available options:

read,

update

orgCapabilities.users

enum<string>[]

Users capability

Available options:

create,

read,

update,

delete

Response

200 - application/json

datasetCapabilities

object

required

Show child attributes

datasetCapabilities.{key}

object

Show child attributes

datasetCapabilities.{key}.ingest

enum<string>[]

Ingest capability

Available options:

create

datasetCapabilities.{key}.query

enum<string>[]

Query capability

Available options:

read

datasetCapabilities.{key}.starredQueries

enum<string>[]

Starred queries capability

Available options:

create,

read,

update,

delete

datasetCapabilities.{key}.virtualFields

enum<string>[]

Virtual fields capability

Available options:

create,

read,

update,

delete

id

string

required

ID of the token

name

string

required

Name of the token

orgCapabilities

object

required

Show child attributes

orgCapabilities.annotations

enum<string>[]

Annotations capability

Available options:

create,

read,

update,

delete

orgCapabilities.apiTokens

enum<string>[]

API tokens capability

Available options:

create,

read,

update,

delete

orgCapabilities.billing

enum<string>[]

Billing capability

Available options:

read,

update

orgCapabilities.dashboards

enum<string>[]

Dashboards capability

Available options:

create,

read,

update,

delete

orgCapabilities.datasets

enum<string>[]

Datasets capability

Available options:

create,

read,

update,

delete

orgCapabilities.endpoints

enum<string>[]

Endpoints capability

Available options:

create,

read,

update,

delete

orgCapabilities.flows

enum<string>[]

Flows capability

Available options:

create,

read,

update,

delete

orgCapabilities.integrations

enum<string>[]

Integrations capability

Available options:

create,

read,

update,

delete

orgCapabilities.monitors

enum<string>[]

Monitors capability

Available options:

create,

read,

update,

delete

orgCapabilities.notifiers

enum<string>[]

Notifiers capability

Available options:

create,

read,

update,

delete

orgCapabilities.rbac

enum<string>[]

Access control capability

Available options:

create,

read,

update,

delete

orgCapabilities.sharedAccessKeys

enum<string>[]

Shared access keys capability

Available options:

read,

update

orgCapabilities.users

enum<string>[]

Users capability

Available options:

create,

read,

update,

delete

description

string

Description of the token

expiresAt

string | null

Expiration date of the token (ISO 8601 format)

token

string