api-keys

Rotate API key

Replaces an API key's secret with a new one, invalidating the old secret immediately. The new secret is returned exactly once, in this response. You must hold the permission to create keys at or above the location the key is pinned to.

Notes.

  • The key keeps its id, name, permissions, location and expiry; lastUsedAt is reset to null. An expired key can be rotated and stays expired.
post/v1/api-keys/{id}/rotate

Request

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

Path parameters

idstring required

API key id.

Response

Success.

Changes

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