• Home
  • Dynatrace API
  • Environment
  • Tokens v1
  • GET token metadata

Tokens API v1 - GET token metadata

We have a new version of this API—Access tokens API. Check it out!

Lists metadata of a Dynatrace API authentication token by the ID of the token. The token itself is not exposed.

Alternatively, you can retrieve metadata by submitting the token itself with the POST token metadata call.

The request produces an application/json payload.

GETManaged https://{your-domain}/e/{your-environment-id}/api/v1/tokens/{id}
SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/tokens/{id}
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v1/tokens/{id}

Authentication

To execute this request, you need Token management (TenantTokenManagement) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The ID of the required token.

pathoptional

Response

Response codes

CodeTypeDescription
200TokenMetadata

Success

404ErrorEnvelope

Failed. The requested token has not been found.

Response body objects

The TokenMetadata object

Metadata of a token.

ElementTypeDescriptionRequired
idstring

The ID of the token.

optional
namestring

The name of the token.

optional
userIdstring

The owner of the token.

optional
revokedboolean

Revocation status of the token. Revoked tokens are disabled.

optional
createdinteger

The creation time as a unix timestamp in milliseconds.

optional
expiresinteger

The expiration time as a unix timestamp in milliseconds.

optional
lastUseinteger

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

optional
scopesstring[]

A list of scopes assigned to the token.

The element can hold these values
  • ActiveGateCertManagement
  • AdvancedSyntheticIntegration
  • AppMonIntegration
  • CaptureRequestData
  • DTAQLAccess
  • DataExport
  • DataImport
  • DataPrivacy
  • Davis
  • DcrumIntegration
  • DiagnosticExport
  • DssFileManagement
  • ExternalSyntheticIntegration
  • InstallerDownload
  • LogExport
  • MemoryDump
  • Mobile
  • PluginUpload
  • ReadConfig
  • ReadSyntheticData
  • RestRequestForwarding
  • RumBrowserExtension
  • RumJavaScriptTagManagement
  • SupportAlert
  • TenantTokenManagement
  • UserSessionAnonymization
  • ViewDashboard
  • ViewReport
  • WriteConfig
  • WriteSyntheticData
  • activeGateTokenManagement.create
  • activeGateTokenManagement.read
  • activeGateTokenManagement.write
  • activeGates.read
  • activeGates.write
  • apiTokens.read
  • apiTokens.write
  • auditLogs.read
  • credentialVault.read
  • credentialVault.write
  • entities.read
  • entities.write
  • events.ingest
  • events.read
  • extensionConfigurations.read
  • extensionConfigurations.write
  • extensionEnvironment.read
  • extensionEnvironment.write
  • extensions.read
  • extensions.write
  • logs.ingest
  • logs.read
  • metrics.ingest
  • metrics.read
  • metrics.write
  • networkZones.read
  • networkZones.write
  • openTelemetryTrace.ingest
  • problems.read
  • problems.write
  • releases.read
  • securityProblems.read
  • securityProblems.write
  • settings.read
  • settings.write
  • slo.read
  • slo.write
  • syntheticLocations.read
  • syntheticLocations.write
  • tenantTokenRotation.write
optional
personalAccessTokenboolean

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

optional

Response body JSON model

json
{
  "id": "acbed0c4-4ef1-4303-991f-102510a69322",
  "name": "myToken",
  "userId": "john.smith",
  "revoked": true,
  "created": 1554076800000,
  "expires": 1585976400000,
  "lastUse": 1554354000000,
  "personalAccessToken": true,
  "scopes": [
    "DataExport",
    "ReadConfig",
    "WriteConfig"
  ]
}

Example

In this example, the request queries the metadata of the admin token, which has the ID of d5836312-5790-4e80-afcf-09971954c3ea.

The API token is passed in the Authorization header.

The token, as displayed in the Dynatrace interface, has the following settings:

Dynatrace API authentication token

Curl

bash
curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/v1/tokens/d5836312-5790-4e80-afcf-09971954c3ea \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

http
https://mySampleEnv.live.dynatrace.com/api/v1/tokens/d5836312-5790-4e80-afcf-09971954c3ea

Response body

json
{
  "id": "d5836312-5790-4e80-afcf-09971954c3ea",
  "name": "admin",
  "userId": "admin@mysampleenv.com",
  "created": "2019-03-13T09:45:40Z",
  "lastUse": "2019-04-04T09:13:23Z",
  "scopes": [
    "ExternalSyntheticIntegration",
    "DataPrivacy",
    "WriteConfig",
    "DssFileManagement",
    "LogExport",
    "DTAQLAccess",
    "ReadConfig",
    "CaptureRequestData",
    "ReadSyntheticData",
    "DataExport",
    "UserSessionAnonymization",
    "MaintenanceWindows",
    "LogImport",
    "TenantTokenManagement"
  ]
}

Response code

200