Rotate an API credential

Replaces a credential with a new one and gives the original a deadline, so consumers can pick up the new secret before the old stops working. The replacement is a new credential with its own identifier and the same authority and scopes; the original keeps working until it expires, then refuses with credential_expired rather than credential_revoked. overlapSeconds may only shorten the window — the default is also the maximum — and zero retires the original immediately. The new secret is in this response and in no other. Some calls need more: credentials:administer is required as well when the target was not created by the caller, and the call is refused scope_missing without it.

post/v1/credentials/{credentialId}/rotate

Request

  • Base URL: https://docs.greatwait.dev (the document declares no server; this is the origin it was published from)
  • URL: https://docs.greatwait.dev/v1/credentials/{credentialId}/rotate
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header Greatwait-Environment and API key in header Greatwait-Project

Path parameters

credentialIdstring required

Request body

overlapSecondsinteger

Response

Rotate an API credential

Changes

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