Tokens API v1 - GET token metadata

This API is deprecated. Use the Access tokens API instead.

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.

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

Authentication

To execute this request, you need an access token with TenantTokenManagement scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
id	string	The ID of the required token.	path	required

Response

Response codes

Code	Type	Description
200	TokenMetadata	Success
404	ErrorEnvelope	Failed. The requested token has not been found.
4XX	ErrorEnvelope	Client side error.
5XX	ErrorEnvelope	Server side error.

Response body objects

The `TokenMetadata` object

Metadata of a token.

Element	Type	Description
created	integer	The creation time as a unix timestamp in milliseconds.
expires	integer	The expiration time as a unix timestamp in milliseconds.
id	string	The ID of the token.
lastUse	integer	The unix timestamp in milliseconds when the token was last used.
name	string	The name of the token.
personalAccessToken	boolean	The token is a personal access token (`true`) or an API token (`false`).
revoked	boolean	Revocation status of the token. Revoked tokens are disabled.
scopes	string[]	A list of scopes assigned to the token. `ActiveGateCertManagement` `AdvancedSyntheticIntegration` `CaptureRequestData` `DTAQLAccess` `DataExport` `DataImport` `DataPrivacy` `Davis` `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` `adaptiveTrafficManagement.read` `analyzers.read` `analyzers.write` `apiTokens.read` `apiTokens.write` `attacks.read` `attacks.write` `auditLogs.read` `bizevents.ingest` `credentialVault.read` `credentialVault.write` `entities.read` `entities.write` `events.ingest` `events.read` `extensionConfigurationActions.write` `extensionConfigurations.read` `extensionConfigurations.write` `extensionEnvironment.read` `extensionEnvironment.write` `extensions.read` `extensions.write` `geographicRegions.read` `hub.install` `hub.read` `hub.write` `javaScriptMappingFiles.read` `javaScriptMappingFiles.write` `logs.ingest` `logs.read` `metrics.ingest` `metrics.read` `metrics.write` `networkZones.read` `networkZones.write` `oneAgents.read` `oneAgents.write` `openTelemetryTrace.ingest` `openpipeline.events` `openpipeline.events.custom` `openpipeline.events_sdlc` `openpipeline.events_sdlc.custom` `openpipeline.events_security` `openpipeline.events_security.custom` `problems.read` `problems.write` `releases.read` `rumCookieNames.read` `securityProblems.read` `securityProblems.write` `settings.read` `settings.write` `slo.read` `slo.write` `syntheticExecutions.read` `syntheticExecutions.write` `syntheticLocations.read` `syntheticLocations.write` `tenantTokenRotation.write` `traces.lookup` `unifiedAnalysis.read`
userId	string	The owner of the token.

Response body JSON model

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

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

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

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

Response body

{
  "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