keys

Rotate an API key

Replace an API key’s secret. Store the returned secret and update the systems using it.

post/api/v1/keys/{key_id}/rotate

Request

  • Base URL: https://api.cumuluslabs.io
  • URL: https://api.cumuluslabs.io/api/v1/keys/{key_id}/rotate
  • Auth: HTTP bearer

Path parameters

key_idstring uuid required

Headers

Idempotency-Keystring required

Request body

KeysRotateRequest required

Response

Replace an API key's secret

key_idstring uuid required
namestring required
role'admin' | 'member' | 'viewer' required
can_dialboolean required
prefixstring required
created_atstring date-time required
last_used_atstring date-time nullable required
expires_atstring date-time nullable required
revoked_atstring date-time nullable required
secretstring required

Changes

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