REST API

Everything the web interface can do, it does over a REST API — so anything the interface can do, a show controller can do too.

The API is served from the device on the same address as the interface. Units are discoverable over mDNS, so automation can find them without hard-coded addresses.

Typical uses:

  • Switch a screen to a given NDI® source at a cue.
  • Start or stop a playlist.
  • Change the output mode, or drop a screen to black.
  • Poll a unit’s health.

Security

If a PIN is set, API requests must be authenticated. Until one is set, the API is open to anyone on the network — set a PIN on any unit that lives on an untrusted network.

A Postman collection is available covering the endpoints — get in touch and we’ll send it over.

Reset & Recovery

Settings persist

Every setting — source, display mode, playlist, network, PIN, fleet membership — is written to the device and survives a reboot or a power cut.

Factory reset

There are three ways to reset a unit, and the third works even when you cannot reach it:

MethodWhen to use it
InterfaceNormal use — System → Factory reset
REST APIAutomated re-provisioning
Hardware buttonHold the button on the unit for 5 seconds. Works with no network at all

A factory reset clears settings and returns Ethernet to DHCP.

The rescue path

This is the combination that gets a unit back from anywhere:

  1. Hold the hardware button for 5 seconds.
  2. The unit resets and raises its own WiFi hotspot, showing a QR code on the display.
  3. Scan it, and you’re back in the interface.

A unit stranded on a static IP for a network that no longer exists is recoverable without a laptop, a serial cable, or opening the case.