Tokens API v1 - GET all tokens

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

Lists all Dynatrace API authentication tokens of your environment. The list contains only the names and IDs of tokens. You can retrieve details either by the ID of the token or by the token itself.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/tokens
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/tokens

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
limit
integer

Limits the maximum number of returned tokens.

If not set the value of 1000 is used.

Maximum value is 1000000.

query
optional
user
string

Filters the resulting set of tokens by user, who owns the token.

query
optional
permissions
string[]

Filters the resulting set of tokens by scopes assigned to the token.

You can specify several permissions in the following format: permissions=scope1&permissions=scope2. The token must have all the specified scopes.

  • 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
query
optional
from
integer

Last used after this timestamp (UTC milliseconds).

query
optional
to
integer

Last used before this timestamp (UTC milliseconds).

query
optional

Response

Response codes

Code
Type
Description
200

Success

4XX

Client side error.

5XX

Server side error.

Response body objects

The StubList object

An ordered list of short representations of Dynatrace entities.

Element
Type
Description
values

An ordered list of short representations of Dynatrace entities.

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element
Type
Description
description
string

A short description of the Dynatrace entity.

id
string

The ID of the Dynatrace entity.

name
string

The name of the Dynatrace entity.

Response body JSON model

{
"values": [
{
"description": "Dynatrace entity 1 for the REST API example",
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity 1"
},
{
"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
"name": "Dynatrace entity 2"
},
{
"id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
}
]
}

Example

In this example, the request lists all API tokens of the mySampleEnv environment.

The API token is passed in the Authorization header.

The result is truncated to three entries.

Curl

curl -X GET \
https://mySampleEnv.live.dynatrace.com/api/v1/tokens \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v1/tokens

Response body

{
"values": [
{
"id": "d5836312-5790-4e80-afcf-09971954c3ea",
"name": "admin"
},
{
"id": "ab42e02c-fbbe-413c-b225-9a87d5efbd60",
"name": "dev token"
},
{
"id": "434d9b21-1e38-4be3-8b90-5a76d531ca53",
"name": "devops"
}
]
}

Response code

200