screens

Send a command to a screen

Queue a command for a screen's device, such as reboot, turning the display on or off, taking a screenshot, or clearing the cache. The device runs the command the next time it checks in.

Queues a device command (reboot, refresh, screenshot, volume, …). Poll GET /v1/screens/{id}/commands/{commandId} for the device's answer.

Notes.

  • A screenshot that coalesces onto an older pending one answers 200 (not 201) with coalesced: true.
post/v1/screens/{id}/commands

Request

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

Path parameters

idstring required

Screen id.

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.

Response

Success.

Changes

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