API reference
Rotate a key
Dashboard
BetaWe just launched Apps: hosted models, actions and pages, on the same bill as your inference.Read the Apps docs

Rotate a key

POSThttps://api.inferencebureau.com/v1/keys/{id}/rotate

Replace a key's secret without downtime: a new key with the same name, project, environment, Directives, permissions and expiry, while the old key keeps working for the overlap and then expires.

Headers

  • Idempotency-Keystringoptional

    Optional, up to 255 visible characters (a UUID). A retry with the same key and body within 24 hours makes nothing new; see Idempotent retries.

Body

application/json, optional
  • overlap_secondsintegeroptional

    How long the old key keeps working: 0 to 604800 (7 days), default 86400. 0 revokes it now. An old key that already expires sooner keeps its expiry.

Response

  • id, secretstringrequired

    The new key and its secret, shown once. The new key has a new id.

  • previousobjectrequired

    The old key, with its new expires_at (or status: "revoked").

Notes

  • Budgetsoptional

    A key-level budget carries on: the new key and the old one (during the overlap) spend from the same day and month periods, so the budget doesn't restart and nothing is counted twice.

  • Auditoptional

    One key.rotate event on the new key, naming the old.