keys

Rotate an API key

Replace a key with a new one carrying the same name, scopes and limits. The new plaintext is in the response and nowhere else. With graceSeconds, the old key keeps working for that long so a fleet can pick the new value up without an outage; with 0 it dies now. A grace window never extends a key that was already expiring sooner.

post/keys/{id}/rotate

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/keys/{id}/rotate
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The resource id, from a create answer or the matching list.

Headers

Idempotency-Keystring required

1–128 characters, unique to this request. A retry with the same key and the same body returns the STORED response with Idempotent-Replayed: true; the same key with a different body is 409 idempotency_conflict; a duplicate still in flight is 409 idempotency_in_progress. Claims expire after 24 hours.

Request body

graceSecondsinteger

How long the old key keeps working, up to a day. 0 revokes it immediately.

Response

Rotate an API key

keystring required

THE KEY. This is the only time it is shown: it is never stored in readable form and cannot be recovered. Save it now; if it is lost, rotate.

Changes

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