Overview

The HTTP API handles simple request/response reads: confirming the backend is running and fetching a module’s current data. For everything else, use the WebSocket API, which is the primary interface and covers most operations: live data, input, media and power control, notifications, settings, and commands.

Note

Most endpoints need your API token. See Authentication.

Base URL

By default the backend listens on port 9170, so the base URL is:

http://{host}:9170

Replace {host} with the hostname or IP address of the machine running System Bridge. The port can be changed with the SYSTEM_BRIDGE_PORT environment variable.

Endpoints

Status & Health Confirm the backend is running. No token required.

Data Fetch a module's current data on demand.

Media File Data Download a media file by base directory and path.