Sign in

v12

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-014994227.2 KB
api-keys

Regenerate an API key

Rotates the plaintext value for an existing API key, preserving its name and identifier. The previous value is invalidated immediately.

post/api-keys/{key_id}/regenerate

Path parameters

key_idstring uuid required

API key identifier to regenerate

API key identifier to regenerate

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

created_atstring date-time required

Timestamp when the key was originally created.

idstring required

API key identifier.

key_valuestring required

New full plaintext key.

namestring required

Human-readable label for the key.

regenerated_atstring date-time required

Timestamp when the key was regenerated.

Example response

{
  "$schema": "/api/v1/APIKeyRegenerateResponse.json"
}