List Cluster token metadata with id

Lists metadata of a Dynatrace Cluster token by the ID of the token.

Endpoint

/api/cluster/v1/tokens

Parameters

Parameter Type Description In Required
id string

The ID of the required token.

path required

Response format

The TokenMetadata object

Metadata of a token.

Element Type Description
id string

The ID of the token.

name string

The name of the token.

userId string

The owner of the token.

revoked boolean

Revocation status of the token. Revoked tokens are disabled.

created integer

The creation time as a unix timestamp in milliseconds.

expires integer

The expiration time as a unix timestamp in milliseconds.

lastUse integer

The unix timestamp in milliseconds when the token was last used.

scopes string[]

The list of permissions, assigned to the token.

Possible values

Possible values for the scopes element in the TokenMetadata object:

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

Response code

Code Description
200

Success.

404

Failed. The requested token has not been found.

Example

In this example, the request queries the metadata of the token, which has the ID of 4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4.

Curl

curl -X GET "https://myManaged.cluster.com/api/cluster/v1/tokens/4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4"
        -H  "accept: application/json; charset=utf-8"

Request URL

https://myManaged.cluster.com/api/cluster/v1/tokens/4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4

Response body

{
  "id": "4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4",
  "name": "myToken",
  "userId": "john.smith",
  "revoked": true,
  "created": 1554076800000,
  "expires": 1585976400000,
  "lastUse": 1554354000000,
  "scopes": [
    "DataExport",
    "ReadConfig",
    "WriteConfig"
  ]
}

Response code

204