Sign in

Mint a fresh secret in place (same id, budgets, usage). The new secret is shown once; the old stops resolving. Honors an `Idempotency-Key` header (per-principal, op+id-scoped, ~10min replay)

Changed on
post/api/v1/admin/keys/{id}/rotate

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header x-admin-token
    • HTTP bearer

Path parameters

idstring required

Response

Rotated (body includes the once-shown new secret; an Idempotency-Key retry replays it verbatim)

allowed_poolsstring[] nullable required
created_atinteger required
enabledboolean required
expires_atinteger nullable

Unix-seconds expiry of the re-minted signed token (present with token).

groupstring nullable required
idstring required
labelsobject required
namestring required
secretstring nullable

The fresh bearer secret, shown EXACTLY once (legacy hashed-secret keys only).

statestring required

Same field as KeyView.state; rotate does not change enabled/revoked/tombstoned status, so this reflects whatever the key's disposition already was (rotating a disabled or revoked key is legal and leaves it exactly that; only a tombstoned key refuses to rotate, which surfaces as 404 instead of this response).

tokenstring nullable

The fresh busbar-SIGNED token, shown EXACTLY once (signed-token keys).

Changes

  • 857732ef7bbeRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      api operation id PostKeysIdRotate was added

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status