screens

Send a command to many screens

Queue the same command across many screens in a single request, using screenIds, kind, and an optional payload. Screen IDs you do not have permission to edit are silently dropped from the request rather than causing an error. Use this instead of sending one request per screen.

Queues one command on many screens. Unknown or out-of-reach ids are silently dropped. Risky kinds (set-proxy, set-input, rs232, add-wifi) on a large cohort go to a small canary batch first and the rest are staged.

Notes.

  • When no requested screen is reachable the answer is 200 (not 201) with { issued: 0, commandIds: [] }.
post/v1/screens/commands

Request

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

Request body

kind'reboot' | 'cec-on' | 'cec-off' | 'clear-cache' | 'refresh' | 'screenshot' | 'start-mirror' | 'stop-mirror' | 'selftest' | 'pull-logs' | 'unlock-kiosk' | 'trigger' | 'set-volume' | 'set-mute' | 'set-brightness' | 'set-input' | 'rs232' | 'rekey' | 'set-proxy' | 'update-player' | 'update-app' | 'clear-obstruction' | 'add-wifi' | 'wake-screen' | 'set-timezone' | 'restart-app' | 'pause-recovery' | 'speed-test' | 'recover-peer' | 'set-fallback-wifi' | 'collect-diagnostics' | 'log-verbose' required
payloadobject

Per-kind payload: set-volume {level 0-100}, set-brightness {level}, set-mute {muted}, set-input {input}, … Most kinds take none.

screenIdsstring[] required

Response

Success.

Changes

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