Access tokens API - GET all tokens

Lists all API tokens available in your environment.

You can limit the output by using the pagination:

Specify the number of results per page in the pageSize query parameter.
Then use the cursor from the nextPageKey field of the previous response in the nextPageKey query parameter to obtain subsequent pages.

The request produces an application/json payload.

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

Authentication

To execute this request, you need an access token with Read API tokens (apiTokens.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.	query	optional
pageSize	integer	The amount of API tokens in a single response payload. The maximal allowed page size is 10000 and the minimal allowed page size is 100. If not set, 200 is used.	query	optional
apiTokenSelector	string	Filters the resulting sets of tokens. Only tokens matching the specified criteria are included into response. You can set one or more of the following criteria: Owner: `owner("value")`. The user that owns the token. Case-sensitive. Personal access token: `personalAccessToken(false)`. Set to `true` to include only personal access tokens or to `false` to include only API tokens. Token scope: `scope("scope1","scope2")`. If several values are specified, the OR logic applies. To set multiple criteria, separate them with commas (`,`). Only results matching all criteria are included into response.	query	optional
fields	string	Specifies the fields to be included in the response. The following fields are included by default: `id` `name` `enabled` `owner` `creationDate` To remove fields from the response, specify them with the minus (`-`) operator as a comma-separated list (for example, `-creationDate,-owner`). You can include additional fields: `personalAccessToken` `expirationDate` `lastUsedDate` `lastUsedIpAddress` `modifiedDate` `scopes` `additionalMetadata` To add fields to the response, specify them with the plus (`+`) operator as a comma-separated list (for example, `+expirationDate,+scopes`). You can combine adding and removing of fields (for example, `+scopes,-creationDate`). Alternatively, you can define the desired set of fields in the response. Specify the required fields as a comma-separated list, without operators (for example, `creationDate,expirationDate,owner`). The ID is always included in the response. The fields string must be URL-encoded.	query	optional
from	string	Filters tokens based on the last usage time. The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week. You can also specify relative timeframe without an alignment: `now-NU`. Supported time units for the relative timeframe are: `m`: minutes `h`: hours `d`: days `w`: weeks `M`: months `y`: years	query	optional
to	string	Filters tokens based on the last usage time. The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week. You can also specify relative timeframe without an alignment: `now-NU`. Supported time units for the relative timeframe are: `m`: minutes `h`: hours `d`: days `w`: weeks `M`: months `y`: years If not set, the current timestamp is used.	query	optional
sort	string	The sort order of the token list. You can sort by the following properties with a sign prefix for the sort order: `name`: token name (`+` a...z or `-` z...a) `lastUsedDate` last used (`+` never used tokens first `-` most recently used tokens first) `creationDate` (`+` oldest tokens first `-` newest tokens first) `expirationDate` (`+` tokens that expire soon first `-` unlimited tokens first) `modifiedDate` last modified (`+` never modified tokens first `-` most recently modified tokens first) If no prefix is set, + is used. If not set, tokens are sorted by creation date with newest first.	query	optional

Response

Response codes

Code	Type	Description
200	ApiTokenList	Success
400	ErrorEnvelope	Failed. The input is invalid.

Response body objects

The `ApiTokenList` object

A list of API tokens.

Element	Type	Description
apiTokens	ApiToken[]	A list of API tokens. Can be `null`.
pageSize	integer	The number of entries per page. Can be `null`.
nextPageKey	string	The cursor for the next page of results. Has the value of `null` on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result. Can be `null`.
totalCount	integer	The total number of entries in the result.

The `ApiToken` object

Metadata of an API token.

Element	Type	Description
lastUsedIpAddress	string	Token last used IP address. Can be `null`.
modifiedDate	string	Token last modified date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`). Updating scopes or name counts as modification, enabling or disabling a token does not. Can be `null`.
additionalMetadata	object	Contains additional properties for specific kinds of token. Examples: A `dashboardId` property for dashboard sharing tokens. A `reportId` property for report sharing tokens Can be `null`.
expirationDate	string	Token expiration date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`). If not set, the token never expires. Can be `null`.
lastUsedDate	string	Token last used date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`) Can be `null`.
personalAccessToken	boolean	The token is a personal access token (`true`) or an API token (`false`). Can be `null`.
creationDate	string	Token creation date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`) Can be `null`.
name	string	The name of the token. Can be `null`.
id	string	The ID of the token, consisting of prefix and public part of the token. Can be `null`.
owner	string	The owner of the token. Can be `null`.
enabled	boolean	The token is enabled (`true`) or disabled (`false`). Can be `null`.
scopes	string[]	A list of scopes assigned to the token. The element can hold these values `ActiveGateCertManagement` `AdvancedSyntheticIntegration` `AppMonIntegration` `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` `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` `geographicRegions.read` `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` `syntheticExecutions.read` `syntheticExecutions.write` `syntheticLocations.read` `syntheticLocations.write` `tenantTokenRotation.write` Can be `null`.

Response body JSON model

json
{
  "pageSize": "1",
  "totalCount": "1",
  "apiTokens": {
    "id": "dt0c01.ST2EY72KQINMH574WMNVI7YN",
    "name": "tokenName",
    "disabled": "false",
    "personalAccessToken": "true",
    "owner": "john.smith",
    "creationDate": "2020-11-05T08:15:30.144Z",
    "expirationDate": "2020-11-12T08:15:30.144Z",
    "lastUsedDate": "2020-11-12T08:15:30.144Z",
    "lastUsedIpAddress": "34.197.2.44",
    "scopes": [
      "metrics.read"
    ],
    "additionalMetadata": {
      "dashboardId": "82402bab-7370-4359-924d-88ed13c8919a"
    }
  }
}