Rotate an API key

Regenerates the key. The new raw key is returned once, in secret. Requires ai-collection-v3:collections:share and the ai-collection-v3:apikeys:create org permission (403 otherwise).

POST /v1/collections/{collection_id}/api-keys/{key_id}/rotate

Rotate an API key

cURL

curl --request POST \
  --url https://{host}/v2/workspaces/slug:ai-collection-v3/webhooks/v1/collections/{collection_id}/api-keys/{key_id}/rotate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expiresAt": "2023-11-07T05:31:56Z"
}
'

200

{
  "id": "<string>",
  "object": "collection.api_key",
  "collection_id": "<string>",
  "slug": "<string>",
  "name": "<string>",
  "scope": "ai-collection-v3:collections:3f2a9c1e-...",
  "permissions": [
    "<string>"
  ],
  "expires_at": 123,
  "secret": "<string>"
}

Authorizations

BearerAuthOrgApiKeyAuth

Authorization · string · header · required

User session JWT. Send as Authorization: Bearer <token>.

Path Parameters

collection_id · string<uuid> · required

Collection identifier returned at creation.

key_id · string · required

Body

application/json

expiresAt · string<date-time>

New expiration date, in the future. Without it, the key keeps its expiration. Required to rotate a key that has already expired (400 otherwise).

Response

200

application/json

Key rotated. secret is shown only once.

API key metadata. The raw key is never included here.

id · string

object · string

Example:

"collection.api_key"

collection_id · string

slug · string

name · string

scope · string

Example:

"ai-collection-v3:collections:3f2a9c1e-..."

permissions · string[]

expires_at · integer

Unix seconds.

secret · string

The raw API key (iak_...). Returned only once, on create and rotate.