STstablesea
api_keys
identity
customer-session

Rotate an API key

Changed on

Atomically replaces a key from your current business and revokes its predecessor. Supply the replacement name and scopes explicitly. Requires api_keys_manage and an Idempotency-Key. Live keys also require a valid two-factor code; Test keys do not. Store the returned secret securely.

post/identity/api_keys/{id}/rotate

Request

  • Base URL
    https://api.stablesea.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.stablesea.com/identity/api_keys/{id}/rotate
  • Auth
    none declared. Required headers: Idempotency-Key

Path parameters

idstring required

Headers

Idempotency-Keystring required

Request body

environment'live' | 'test'
namestring required
scopesstring[] nullable
totp_codestring

Required for Live keys; omitted for Test keys

Response

OK

secretstring

Changes