List the ActiveGate tokens in your Dynatrace environment with the Fleet Management API, page by page, to review which tokens exist and when they expire.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/v1/activegate/tokens |
You use this operation to list the ActiveGate tokens of your environment. The response is paginated: set page-size for the number of tokens per page and pass the nextPageKey from a previous response as page-key to get the next page. The response contains token metadata only, never the token secrets.
To execute this request, you need a platform token or OAuth access token with fleet-management:activegate.tokens:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| page-key | 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 page-key query parameter. When the page-key is set to obtain subsequent pages, you must omit all other query parameters. | query | Optional |
| page-size | integer | The amount of ActiveGate tokens in a single response payload. The maximal allowed page size is 3000 and the minimum size is 100. If not set, 100 is used. | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Active | Success. The response contains the list of ActiveGate tokens. |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
ActiveGateTokenList objectA list of ActiveGate tokens.
| Element | Type | Description |
|---|---|---|
| activeGateTokens | Active | A list of ActiveGate tokens. |
| nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the page-key query parameter to obtain subsequent pages of the result. |
| pageSize | integer | The number of entries per page. |
| totalCount | string | The total number of entries in the result. |
ActiveGateToken objectMetadata of an ActiveGate token.
| Element | Type | Description |
|---|---|---|
| creationDate | string | The token creation date in ISO 8601 format ( |
| expirationDate | string | The token expiration date in ISO 8601 format ( If not set, the token never expires. |
| id | string | The ActiveGate token identifier, consisting of the prefix and public parts of the token. |
| lastUsedDate | string | The token last used date in ISO 8601 format ( |
| name | string | The name of the token. |
| owner | string | The owner of the token. |
| seedToken | boolean | The token is a seed token ( |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| code | integer | The HTTP status code |
| constraintViolations | Constraint | A list of constraint violations |
| message | string | The error message |
ConstraintViolation objectA list of constraint violations
| Element | Type | Description |
|---|---|---|
| location | string | - |
| message | string | - |
| parameterLocation | string | -The element can hold these values
|
| path | string | - |
{"activeGateTokens": [{"creationDate": "2020-11-22T08:15:30.144Z","expirationDate": "2020-11-24T08:15:30.144Z","id": "dt0g02.4KWZO5EF","lastUsedDate": "2020-11-23T08:15:30.144Z","name": "myToken","owner": "john.smith","seedToken": false}],"nextPageKey": "AQAAABQBAAAABQ==","pageSize": 100,"totalCount": "1000"}
{"error": {"code": 1,"constraintViolations": [{"location": "string","message": "string","parameterLocation": "HEADER","path": "string"}],"message": "string"}}