This is an old revision of the document!
Table of Contents
REST Remote Control
The REST remote control interface provides a RESTful API, allowing third-party software to access state information, and perform actions, through HTTP calls.
Configuration
Open the standalone configuration app, or the Control Panel, go to the Remote Control page, and add a new REST Remote Access remote control.
General Settings
Specify the TCP Port that the HTTP server should listen on. The default port is 9300.
SSL is currently not supported.
User Management
Unless you enable anonymous access, all users must authenticate themselves through HTTP Basic Authentication.
Note that all users have the same permissions (with regard to the enabled plugins, see below). If you want to have multiple users with different permissions, you must run multiple REST remotes on different ports.
Plugins
Endpoint URLs are provided through plugins, which can be enabled or disabled as required. See the plugin description below for the available URLs.
Plugins
General status (GeneralRead)
This plugin provides the following endpoints:
GET /status/onair
Returns the current ON AIR status (1 = ON AIR, 0 = OFF AIR).
GET /runtimedata/<key>
Returns the current value of the runtime data value (set in a script via SetRuntimeData(key, value)).
Playlist read access (PlaylistRead)
This plugin provides the following endpoints:
Command execution (Execute command)
This plugin provides the following endpoints:
POST /execute
Executes a remote control command, which must be passed as the command parameter in the POST body.
Encoder status (Encoder)
This plugin provides the following endpoints: