Tenant tokens API - POST cancel rotation

  • Reference

Cancels the rotation of the tenant token. The new token is discarded and the old token remains valid. If you configured any OneAgents and ActiveGates to use the new token, you must restore the old configuration.

The request produces an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/tenantTokenRotation/cancel
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/tenantTokenRotation/cancel

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

CodeTypeDescription
200TenantTokenConfig

Success. Rotation process has been cancelled. The current tenant token remains valid.

400ErrorEnvelope

Failed. There is no ongoing rotation process.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The TenantTokenConfig object

Configuration of a tenant token.

ElementTypeDescription
activeTenantToken

Tenant token

oldTenantToken

Tenant token

The TenantToken object

Tenant token

ElementTypeDescription
valuestring

The secret of the tenant token.

Response body JSON model

{
  "active": {
    "value": "string"
  },
  "old": {}
}

Example

In this example, the request cancels the rotation process started in start request example.

The response code of 200 indicates a successful request. The old token 1234567890qrstuvwxyz remains valid; the new token is discarded.

The API token is passed in the Authorization header.

Curl

curl -X POST \
  https://mySampleEnv.live.dynatrace.com/api/v2/tenantTokenRotation/finish \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Accept: application/json'

Response body

{
  "active": {
    "value": "1234567890qrstuvwxyz"
  },
  "old": {
    "value": null
  }
}

Response code

200