screens

Create a screen

Create a screen. name is required; nodeId, location, and tags are optional. This operation is safe to retry with an idempotency key. Each screen created increases your billed screen count, so this request is refused if your account is suspended or cancelled.

Notes.

  • Returns the stored row, not the composed Screen that GET /v1/screens/{id} returns: tags is the JSON-encoded string, and the composed fields (contentName, state, …) are absent.
  • The screen waits in pairing status until a device claims it (POST /v1/screens/{id}/claim-replacement) — or use POST /v1/screens/claim or /v1/screens/enroll, which create and pair in one step.
post/v1/screens

Request

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

Request body

namestring required
nodeIdstring

Location to create it in; default: the API key's own location, else the workspace root.

billingGroupIdstring nullable

Billing group that pays for the screen.

Response

Success.

Example response

{
  "data": {
    "id": "scr_1a2b3c4d5e6f7a8b"
  }
}

Changes

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