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 | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/apiTokens |
Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/apiTokens |
Authentication
To execute this request, you need an access token with apiTokens.read
scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
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.
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.
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 totrue
to include only personal access tokens or tofalse
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.
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.
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 theT
. Seconds and fractions of a second are optional. - Relative timeframe, back from now. The format is
now-NU/A
, whereN
is the amount of time,U
is the unit of time, andA
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
: minutesh
: hoursd
: daysw
: weeksM
: monthsy
: years
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 theT
. Seconds and fractions of a second are optional. - Relative timeframe, back from now. The format is
now-NU/A
, whereN
is the amount of time,U
is the unit of time, andA
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
: minutesh
: hoursd
: daysw
: weeksM
: monthsy
: years
If not set, the current timestamp is used.
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.
Response
Response codes
Response body objects
The ApiTokenList
object
A list of API tokens.
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.
The number of entries per page.
The total number of entries in the result.
The ApiToken
object
Metadata of an API token.
Contains additional properties for specific kinds of token. Examples:
- A
dashboardId
property for dashboard sharing tokens. - A
reportId
property for report sharing tokens
Token creation date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
)
The token is enabled (true
) or disabled (false
).
Token expiration date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
).
If not set, the token never expires.
The ID of the token, consisting of prefix and public part of the token.
Token last used date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
)
Token last used IP address.
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.
The name of the token.
The owner of the token.
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
Response body JSON model
{"apiTokens": {"additionalMetadata": {"dashboardId": "82402bab-7370-4359-924d-88ed13c8919a"},"creationDate": "2020-11-05T08:15:30.144Z","disabled": "false","expirationDate": "2020-11-12T08:15:30.144Z","id": "dt0c01.ST2EY72KQINMH574WMNVI7YN","lastUsedDate": "2020-11-12T08:15:30.144Z","lastUsedIpAddress": "34.197.2.44","name": "tokenName","owner": "john.smith","personalAccessToken": "true","scopes": ["metrics.read"]},"pageSize": "1","totalCount": "1"}