Update Cluster token

Updates the specified Dynatrace Cluster token. You can:

  • Change the token name.
  • Revoke the token.
    A revoked token still exists in the environment, but it can't be used.
  • Change the scope of a token.

Endpoint

/api/cluster/v1/tokens

Parameters

Parameter Type Description In Required
id string

The ID of the token to be updated.

You can't update the token you're using for authentication of the request.

path required
body UpdateToken

The JSON body of the request. Contains updated parameters of the token.

body optional

Body format

The UpdateToken object

Element Type Description Required
revoked boolean

The token is revoked (true) or active (false).

optional
name string

The name of the token.

optional
scopes string[]

The list of permissions assigned to the token.

Apart from the new permissions, you need to submit the existing permissions you want to keep, too. Any existing permission, missing in the payload, is revoked.

  • DiagnosticExport: DiagnosticExport.
  • ControlManagement: ControlManagement.
  • UnattendedInstall: UnattendedInstall.
  • ServiceProviderAPI: Service Provider API.
  • ExternalSyntheticIntegration: Create and read synthetic monitors, locations, and nodes.
  • ClusterTokenManagement: Cluster token management.
  • ReadSyntheticData: Read synthetic monitors, locations, and nodes.
  • Nodekeeper: Nodekeeper access for node management.
  • EnvironmentTokenManagement: "Token Management" Token creation for existing environments.
optional

Response

Response codes

Code Description
204

Success. The token has been updated.

400

Failed. You can't update the token you're using for authentication of the request.

404

Failed. The requested token has not been found.

Response body

A successful request doesn't return any content.

Example

In this example, the request queries the metadata of the specific token, which has the ID of 4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4. It changes the token scope by updating the token metadata. The name and validity of the token remain intact. The response code of 204 indicates that the update was successful.

Curl

curl -X PUT "https://myManaged.cluster.com/api/cluster/v1/tokens/4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4"
        -H  "accept: application/json; charset=utf-8"
        -H  "Content-Type: application/json; charset=utf-8"
        -d  "{  \"revoked\": \"true\",  \"name\": \"updated token\",  \"scopes\": [    \"UnattendedInstall\"  ]}"

Request URL

https://myManaged.cluster.com/api/cluster/v1/tokens/4e9f128e-04f9-4795-pj319-8b7c-3c14a5e885e4

Request body

api-examples/cluster/token/put-cluster-token.json
Download
{
  "revoked": "true",
  "name": "updated token",
  "scopes": [
    "UnattendedInstall"
  ]
}

Response code

204