List available Cluster tokens
You can narrow down the output by adding parameters. The token has to match all the specified parameters.
You can also specify the limit of returned tokens.
This list may contain tokens which were created automatically (for example, InstallerDownload, Mobile, ...) and are not visible on the Settings page. Deleting these might have unintended side-effects as they may still be in use.
Endpoint
/api/cluster/v2/tokens
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
limit | integer |
Limits the maximum number of returned tokens. If not set the value of Maximum value is 1000000. |
query | optional |
user | string |
Filters the resulting set of tokens by user, who owns the token. |
query | optional |
permissions | array |
Filters the resulting set of tokens by permissions, assigned to the token. You can specify several permissions in the following format: |
query | optional |
from | integer |
Last used after this timestamp (UTC milliseconds). |
query | optional |
to | integer |
Last used before this timestamp (UTC milliseconds). |
query | optional |
Response
Response codes
Code | Description |
---|---|
200 | Success |
Response body
The StubList object
An ordered list of short representations of Dynatrace entities.
Element | Type | Description |
---|---|---|
values | EntityShortRepresentation[] | An ordered list of short representations of Dynatrace entities. |
The EntityShortRepresentation object
The short representation of a Dynatrace entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the Dynatrace entity. |
name | string | The name of the Dynatrace entity. |
description | string | A short description of the Dynatrace entity. |
{
"values": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity 1",
"description": "Dynatrace entity 1 for the REST API example\n"
},
{
"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
"name": "Dynatrace entity 2"
},
{
"id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
}
]
}
Example
In this example, the request lists API tokens in the myManaged.cluster.com
environment for user Pete
with cluster token management permissions.
Curl
curl -X GET "https://myManaged.cluster.com/api/cluster/v2/tokens?limit=1000&user=Pete&permissions=ClusterTokenManagement"
-H "accept: application/json; charset=utf-8"
Request URL
https://myManaged.cluster.com/api/cluster/v2/tokens?limit=1000
Response body
{
"values": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity 1",
"description": "Dynatrace entity 1 for the REST API example"
},
{
"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
"name": "Dynatrace entity 2"
},
{
"id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
}
]
}
Response code
200