API authentication tokens API - PUT a token

Updates the specified API token. You can:

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

The request consumes an application/json payload.

PUT
  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/apiTokens/{id}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/apiTokens/{id}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/apiTokens/{id}

Authentication

To execute this request, you need the Write API tokens (apiTokens.write) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
id string

The ID of the token to be updated.

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

path required
body ApiTokenUpdate

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

body optional

Body format

The ApiTokenUpdate object

The update of the API token.

Element Type Description Required
name string

The name of the token.

optional
enabled boolean

The token is enabled (true) or disabled (false)

optional

Response

Response codes

Code Description
204

Success. Response doesn't have a body.

400

Failed. The input is invalid.

Response body

A successful request doesn't return any content.