screens

Enroll a screen programmatically

Create a screen and pair it in a single call using a workspace API key, without a 6-digit pairing code. This is intended for automated device provisioning. The returned device token is shown once and cannot be retrieved again. The screen is created in the workspace the API key belongs to; an API key scoped to one organization node creates the screen under that node, while an account-wide key can target any node in the account.

post/v1/screens/enroll

Request

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

Request body

namestring

Default New screen.

nodeIdstring
billingGroupIdstring nullable

Response

Success.

Changes

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