Tenant tokens API - POST start rotation
Initiates the rotation of the tenant token. The request creates a new tenant token that you must add to the configuration of your OneAgents and ActiveGates. For a full description of the rotation process, see Rotate tenant token.
To avoid data loss, both old and new tokens are valid during the rotation process. During rotation, do not deploy any new OneAgents until all your ActiveGates are configured with the new tenant token.
The request produces an application/json
payload.
POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/tenantTokenRotation/start |
Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/tenantTokenRotation/start |
Authentication
To execute this request, you need an access token with tenantTokenRotation.write
scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
The request doesn't provide any configurable parameters.
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Tenant | Success. The new tenant token is created and will replace the old one. The active field of the response contains the new tenant token. |
400 | Error | Failed. Another rotation process is already in progress. |
4XX | Error | Client side error. |
5XX | Error | Server side error. |
Response body objects
The TenantTokenConfig
object
Configuration of a tenant token.
Element | Type | Description |
---|---|---|
active | Tenant | Tenant token |
old | Tenant | Tenant token |
The TenantToken
object
Tenant token
Element | Type | Description |
---|---|---|
value | string | The secret of the tenant token. |
Response body JSON model
{"active": {"value": "string"},"old": {}}
Example
In this example, the request starts the rotation process for the mySampleEnv environment.
The response code of 200 indicates a successful request. The newly generated token is zyxwvutsrq0987654321.
The API token is passed in the Authorization header.
Curl
curl -X POST \https://mySampleEnv.live.dynatrace.com/api/v2/tenantTokenRotation/start \-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \-H 'Accept: application/json'
Response body
{"active": {"value": "zyxwvutsrq0987654321"},"old": {"value": "1234567890qrstuvwxyz"}}
Response code
200