v8

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-05730512.7 KB

API Keys

Rotate an API key

Rotate an API key's token. The old token is invalidated and the new full token is returned once — store it immediately. You may rotate your own key; rotating another member's key requires API-key management permission.

post/v1/api-keys/{uuid}/rotate

Path parameters

uuidstring uuid required

UUID of the API key to rotate.

Response

The API key was rotated. The new full token is returned once.

uuidstring uuid

You receive the UUID for this API key.

namestring

You receive the API key name.

environmentstring

You receive the environment for this key: sandbox or prod.

rolestring

You receive the role granted to this key.

created_atstring date-time

You receive the timestamp when the key was created.

tokenstring

You receive the full API key token. Store it now — it is only returned once.

notestring

You receive a reminder that the token is only shown once.

Example response

{
  "uuid": "d1e2f3a4-b5c6-7d80-9e1f-2a3b4c5d6e7f",
  "name": "default",
  "environment": "sandbox",
  "role": "owner",
  "created_at": "2026-07-02T23:51:58.746686+00:00",
  "token": "sk_live_3f9a1c...s9Zx",
  "note": "Save this API key now. It will not be shown again."
}