api-keys

Create API key

Creates a new API key. Provide name, permissions (a list of resource.action strings, or "all"), and an optional nodeId to restrict the key to one location and everything beneath it. The raw key secret is returned exactly once, in this response; only its hash is stored afterward, so it cannot be retrieved again.

post/v1/api-keys

Request

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

Request body

namestring required
nodeIdstring nullable

Pin the key to this location. Omit for a workspace-wide key, which needs its permissions workspace-wide.

expiresInDaysnumber nullable

Days until the key stops working (at most 3650). Omit, null or 0 = never expires.

Response

Success.

Changes

No recorded changes to this operation across all 2 revisions of this API.