Rotate a key (keys:admin)

POST 
/api/v1/keys/:id/rotate

Required scope: keys:admin. Mints a replacement key carrying the old key's scopes, IP allow-list and mode BYTE-FOR-BYTE (rotation takes no parameters — an empty JSON body only), revokes the old key in the same transaction, and stamps lastRotatedAt. Reveal-once response, replayed for 1 hour under the same Idempotency-Key.

Request

Responses

201

The replacement key (reveal-once).

400

400 — INVALID_JSON, VALIDATION_ERROR, or IDEMPOTENCY_KEY_REQUIRED.

401

401 — INVALID_SIGNATURE or SIGNING_NOT_CONFIGURED (or bearer auth failure).

403

403 — missing scope (FORBIDDEN_SCOPE) or module (FORBIDDEN_MODULE).

404

404 — not found OR owned by another tenant (NOT_FOUND; IDOR-safe).

422

ROTATE_REJECTED — only an active key can be rotated.

429

429 — RATE_LIMITED (per-key limit, reads and writes alike; fails closed, so a limiter outage also returns 429). A limiter-down 429 is deliberately indistinguishable from a quota 429. Carries Retry-After (seconds).

Response Headers

Retry-After

Seconds to wait before retrying (429 only).

RateLimit-Limit

Per-minute request ceiling for this key's tier.

RateLimit-Remaining

Requests left in the current window (floored at 0).

RateLimit-Reset

Seconds until the window resets.

503

503 — the API is not enabled on this environment (FEATURE_DISABLED).