SelfAPI Token

updateApiToken

PUT
/api/v1/self/apitokens/{apitoken_id}

Update User API Token

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

apitoken_id*string
Formatuuid

Request Body

application/json

User API token metadata

name?string

Display label for this user API token

Response Body

curl -X PUT "https://example.com/api/v1/self/apitokens/000000ab-00ab-00ab-00ab-0000000000ab" \  -H "Content-Type: application/json" \  -d '{    "name": "org_token_xyz"  }'
{  "created_time": 1626875902,  "id": "864f351a-1377-4ad9-83f8-72f3fe6199ba",  "key": "1qkb...QQCL",  "last_used": 1690115110,  "name": "org_token_xyz"}