• Home
  • Dynatrace API
  • Environment
  • Tokens v2
  • ActiveGate tokens
  • GET all tokens

ActiveGate tokens API - GET all tokens

Lists all ActiveGate tokens available for your environment.

You can limit the output by using the pagination:

  1. Specify the number of results per page in the pageSize query parameter.
  2. 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.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/activeGateTokens
Environment ActiveGatehttps://{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

ParameterTypeDescriptionInRequired
nextPageKeystring

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.

queryoptional
pageSizeinteger

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.

queryoptional

Response

Response codes

CodeTypeDescription
200ActiveGateTokenList

Success. The response contains the list of ActiveGate tokens.

400ErrorEnvelope

Failed. The input is invalid.

404ErrorEnvelope

Failed. The requested resource doesn't exist.

Response body objects

The ActiveGateTokenList object

A list of ActiveGate tokens.

ElementTypeDescription
totalCountinteger

The total number of entries in the result.

pageSizeinteger

The number of entries per page.

nextPageKeystring

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.

activeGateTokensActiveGateToken[]

A list of ActiveGate tokens.

The ActiveGateToken object

Metadata of an ActiveGate token.

ElementTypeDescription
idstring

The ActiveGate token identifier, consisting of prefix and public part of the token.

namestring

The name of the token.

ownerstring

The owner of the token.

creationDatestring

The token creation date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z').

expirationDatestring

The token expiration date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z').

If not set, the token never expires.

lastUsedDatestring

The token last used date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z').

seedTokenboolean

The token is a seed token (true) or an individual token (false).

activeGateTypestring

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

Related topics
  • Dynatrace ActiveGate

    Understand the basic concepts related to ActiveGate.