API authentication tokens API - POST token lookup

Gets metadata of the API token by its secret.

The request consumes and produces an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/apiTokens/lookup
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/apiTokens/lookup
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/apiTokens/lookup

Authentication

To execute this request, you need any permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
body ApiTokenSecret

The JSON body of the request. Contains the required token.

body optional

Body format

The ApiTokenSecret object

Element Type Description Required
token string

The API token.

required

Response

Response codes

Code Description
200

Success

404

Failed. The requested resource doesn't exist.

Response body

The ApiToken object

Metadata of an API token.

Element Type Description
lastUsedDate string

Token last used date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

lastUsedIpAddress string

Token last used IP address.

expirationDate string

Token expiration date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

personalAccessToken boolean

The token is a personal access token (true) or an API token (false).

scopes string[]

A list of scopes assigned to the token.

creationDate string

Token creation date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

name string

The name of the token.

id string

The ID of the token, consisting of prefix and public part of the token.

owner string

The owner of the token.

enabled boolean

The token is enabled (true) or disabled (false).