Create new Cluster token

Creates a new Dynatrace Cluster token. The response contains the newly created token.

The request consumes and produces an application/json payload.

Endpoint

/api/cluster/v1/tokens

Parameters

Parameter Type Description In Required
body CreateClusterToken body optional

The CreateClusterToken object

Element Type Description Required
name string

The name of the token.

required
expiresIn Duration optional
scopes string[]

The list of permissions, assigned to the token.

The scopes element can hold these values.
required

The Duration object

Defines a period of time.

Element Type Description Required
value integer

The amount of time.

required
unit string

The unit of time.

If not set, millisecond is used.

The unit element can hold these values.
optional

Possible values

Possible values for the scopes element in the CreateClusterToken object:

  • ClusterTokenManagement
  • ControlManagement
  • DiagnosticExport
  • ExternalSyntheticIntegration
  • Nodekeeper
  • ReadSyntheticData
  • ServiceProviderAPI
  • UnattendedInstall

Possible values for the unit element in the Duration object:

  • DAYS
  • HOURS
  • MILLIS
  • MINUTES
  • SECONDS

Response format

The Token object

Element Type Description
token string

Dynatrace API authentication token.

Response code

Code Description
201

Success. The token has been created. The response body contains the token itself.

400

Failure. Token was not created due to invalid input.

Example

In this example, the request creates a new token named Mytoken that is valid for 24 hours. With this token you will be able to perform a diagnostic export (DiagnosticExport) and unattended install (UnattendedInstall).

Curl

curl -X POST "https://myManaged.cluster.com/api/cluster/v1/tokens"
          -H "accept: application/json; charset=utf-8"
          -H "Content-Type: application/json; charset=utf-8"
          -d "{  \"name\": \"MyToken\",  \"scopes\": [    \"DiagnosticExport\",    \"UnattendedInstall\"  ],  \"expiresIn\": {    \"value\": 24,    \"unit\": \"HOURS\"  }}"

Request URL

https://myManaged.cluster.com/api/cluster/v1/tokens

Request body

api-examples/cluster/token/post-cluster-token.json
Download
{
  "name": "MyToken",
  "scopes": [
    "DiagnosticExport",
    "UnattendedInstall"
  ],
  "expiresIn": {
    "value": 24,
    "unit": "HOURS"
  }
}

Response body

{
  "token": "abcdefjhij1234567890"
}

Response code

201