Access tokens API - GET a token
Gets metadata of the API token by its ID.
The request produces an application/json
payload.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/apiTokens/{id} |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/apiTokens/{id} | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/apiTokens/{id} |
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
Parameter | Type | Description | In | Required |
---|---|---|---|---|
id | string | The ID of the token. | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Api | Success |
400 | ErrorEnvelope | Failed. The input is invalid. |
404 | Failed. The requested resource doesn't exist. |
Response body objects
The ApiToken
object
Metadata of an API token.
Element | Type | Description |
---|---|---|
additionalMetadata | object | Contains additional properties for specific kinds of token. Examples:
|
creationDate | string | Token creation date in ISO 8601 format ( |
enabled | boolean | The token is enabled ( |
expirationDate | string | Token expiration date in ISO 8601 format ( If not set, the token never expires. |
id | string | The ID of the token, consisting of prefix and public part of the token. |
lastUsedDate | string | Token last used date in ISO 8601 format ( |
lastUsedIpAddress | string | Token last used IP address. |
modifiedDate | string | Token last modified date in ISO 8601 format ( |
name | string | The name of the token. |
owner | string | The owner of the token. |
personalAccessToken | boolean | The token is a personal access token ( |
scopes | string[] | A list of scopes assigned to the token. |
Response body JSON model
{
"additionalMetadata": {
"dashboardId": "82402bab-7370-4359-924d-88ed13c8919a"
},
"creationDate": "2020-11-05T08:15:30.144Z",
"enabled": true,
"expirationDate": "2020-11-12T08:15:30.144Z",
"id": "dt0c01.ST2EY72KQINMH574WMNVI7YN",
"lastUsedDate": "2020-11-12T08:15:30.144Z",
"lastUsedIpAddress": "34.197.2.44",
"modifiedDate": "2020-11-12T08:15:30.144Z",
"name": "myToken",
"owner": "john.smith",
"personalAccessToken": true,
"scopes": [
"metrics.read"
]
}