Regenerate a token

PUT /api/tokens/{token_id}/regenerate

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

In: header

Path Parameters

token_id*string

The unique identifier of the token.

Match^[a-zA-Z0-9-_.]+$

Length1 <= length <= 256

Request Body

application/json

Regenerate a token.

expires_at*integer

The expiration timestamp of the token. 0 means the token will not expire.

Formatint32

Response Body

`application/json`

curl -X PUT "$API_BASE_URL/api/tokens/bd58fce2-b6cc-4d2d-a53c-6ce11b19c101/regenerate" \  -H "Content-Type: application/json" \  -d '{    "expires_at": 1752288235  }'

Access token created successfully. The token value is only returned once at creation time.

{
  "value": {
    "id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101",
    "name": "test-token",
    "created_at": 1742288232,
    "updated_at": 1742288235,
    "expires_at": 1752288235,
    "user_id": "b32e678e-7f6b-4a50-b113-550621ed4c01",
    "org_id": "bc1b95c9-b348-4832-acc3-e257d2342df1",
    "token": "a7ee-example-token"
  }
}

Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.

{
  "value": {},
  "error_msg": "error message"
}

Complete operation details and schema variants

PUT /api/tokens/{token_id}/regenerate

Regenerate a token

Regenerate the secret value of an existing API access token. Clients must replace stored credentials after regeneration.

Parameters

token_id (path, string, required): The unique identifier of the token.

Request body

Content type: application/json

expires_at (integer, required): The expiration timestamp of the token. 0 means the token will not expire.

Responses

200: Access token created successfully. The token value is only returned once at creation time.
allOf variant 1
value (object, optional): The specific resource.
allOf variant 2
value (object, optional):
allOf variant 1
value.id (string, optional): The token ID.
value.name (string, optional): The token name.
value.created_at (integer, optional): The time when a token is created.
value.updated_at (integer, optional): The time when a token is updated.
value.expires_at (integer, optional): The expiration timestamp of the token. 0 means the token will not expire.
value.user_id (string, optional): The user ID.
value.org_id (string, optional): The organization ID.
allOf variant 2
value.token (string, optional): The created token.
400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
value (object, optional): The specific resource.
error_msg (string, optional): The error message.

cURL

curl -X PUT '$API_BASE_URL/api/tokens/{token_id}/regenerate'

Regenerate a token

200application/json

400application/json

`application/json`

`application/json`