Skip to main content
POST
Issue a new plaintext secret for an existing key, in place. Preserves the row’s id, name, scopes, rate limit, and expiration — only the secret (and therefore key_hash + key_prefix) changes. The old plaintext stops working the instant this commits, so callers should orchestrate the cutover: deploy the new value before calling rotate, OR have a brief outage if you can tolerate it. A key can rotate itself; the response carries the new plaintext, but the caller must update their auth header on the next request.

Path parameters

string (uuid)
required

Response

CreateAPIKeyResponse
string
required
string
required
string
required
Plaintext API key — store it now. The platform only retains the SHA-256 hash; this is the one and only time the secret is exposed.
string
required
string[]
required
integer
required
string
required

Status codes