Keys

Rotate key (new secret displayed only once)

Permitted for active, unexpired keys only. Creates a new key (inheriting label, limits, cu_cap, expires_at, and settled cu_spent; quota not reset by rotation) and revokes old key; the old key is refused by the gateways normally within about 1 second, and at most 5 seconds if a change notification is lost; replaced in response is revoked old key whose replaced_by_key_id matches new key key_id.

The original key must first be enabled, unrevoked and unexpired, otherwise 409 key_not_active. Rotation does not add to the live-key count but remains subject to the rolling 24-hour creation cap (429 rate_limited, error.reason daily_creations, Retry-After: 3600). It preserves the original limits, expiry and settled spending rather than resetting them.

post/keys/{key_id}/rotate

Request

  • Base URL: https://console-api.blockvectra.com/v1
  • URL: https://console-api.blockvectra.com/v1/keys/{key_id}/rotate
  • Auth: HTTP bearer

Path parameters

key_idstring required

Response

New key, its secret (displayed only this once), and revoked old key.

api_keystring required

Key secret, displayed only this once.

Example response

{
  "key": {
    "created_at": "2026-09-26T08:00:00Z",
    "revoked_at": "2026-09-26T08:00:00Z",
    "expires_at": "2026-09-26T08:00:00Z"
  },
  "replaced": {
    "created_at": "2026-09-26T08:00:00Z",
    "revoked_at": "2026-09-26T08:00:00Z",
    "expires_at": "2026-09-26T08:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.