ActiveGate tokens API - GET all tokens

Lists all ActiveGate tokens available for 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	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/activeGateTokens`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens`

Authentication

To execute this request, you need an access token with activeGateTokenManagement.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 ActiveGate tokens in a single response payload. The maximal allowed page size is 3000 and the minimal size is 100. If not set, 100 is used.	query	optional

Parameter

Type

Description

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 ActiveGate tokens in a single response payload.

The maximal allowed page size is 3000 and the minimal size is 100.

If not set, 100 is used.

query

optional

Response

Response codes

Code	Type	Description
200	ActiveGateTokenList	Success. The response contains the list of ActiveGate tokens.
400	ErrorEnvelope	Failed. The input is invalid.
404	ErrorEnvelope	Failed. The requested resource doesn't exist.

Response body objects

The `ActiveGateTokenList` object

A list of ActiveGate tokens.

Element	Type	Description
totalCount	integer	The total number of entries in the result.
pageSize	integer	The number of entries per page.
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.
activeGateTokens	ActiveGateToken[]	A list of ActiveGate tokens.

The `ActiveGateToken` object

Metadata of an ActiveGate token.

Element	Type	Description
id	string	The ActiveGate token identifier, consisting of prefix and public part of the token.
name	string	The name of the token.
owner	string	The owner of the token.
creationDate	string	The token creation date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
expirationDate	string	The token expiration date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`). If not set, the token never expires.
lastUsedDate	string	The token last used date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
seedToken	boolean	The token is a seed token (`true`) or an individual token (`false`).
activeGateType	string	The type of the ActiveGate for which the token is valid. The element can hold these values `ENVIRONMENT` `CLUSTER`

Response body JSON model

json
{
  "totalCount": 1000,
  "pageSize": 100,
  "nextPageKey": "AAAAAAAAAAAAAABOAAAAAAAAAAAAAAA6ACQAEAAAABgACgAITFdXQk1BRzYAAAhtZXRhZGF0YQB___-bf___m3iIYxfF7xVQvY72rwblQkcAAwAAAAAAAADHAAAAZA==",
  "activeGateTokens": {
    "id": "dt0g02.4KWZO5EF",
    "name": "myToken",
    "owner": "john.smith",
    "creationDate": "2020-11-22T08:15:30.144Z",
    "expirationDate": "2020-11-24T08:15:30.144Z",
    "lastUsedDate": "2020-11-23T08:15:30.144Z",
    "seedToken": "false",
    "activeGateType": "ENVIRONMENT"
  }
}

Example

In this example, the request lists all ActiveGate tokens available for the mySampleEnv environment.

The API token is passed in the Authorization header.

The result is truncated to three entries.

Curl

bash
curl --request GET \
  --url https://mySampleEnv.live.dynatrace.com//api/v2/activeGateTokens \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com//api/v2/activeGateTokens

Response body

json
{
  "totalCount": 3,
  "pageSize": 3,
  "activeGateTokens": [
    {
      "id": "dt0g02.abc123",
      "name": "system:installer",
      "owner": "max.mustermann@company.com",
      "creationDate": "2021-11-22T11:39:29.797Z",
      "seedToken": true,
      "activeGateType": "ENVIRONMENT"
    },
    {
      "id": "dt0g02.321cba",
      "name": "system:installer",
      "owner": "john.smith@company.com",
      "creationDate": "2021-11-30T14:11:40.913Z",
      "seedToken": true,
      "activeGateType": "ENVIRONMENT"
    },
    {
      "id": "dt0g02.123abc",
      "name": "system:initial-setup",
      "owner": "mary.brown@company.com",
      "creationDate": "2021-10-22T13:48:00.135Z",
      "lastUsedDate": "2021-12-02T11:52:17.201Z",
      "seedToken": false,
      "activeGateType": "ENVIRONMENT"
    },
  ]
}

Response code

200