Command API

Solstice Host URL: IPAddress/api/control

The Command API addresses runtime control of a Solstice host from a third-party application. Commands are executed by issuing a GET to the URL that corresponds to the command to be executed. The Command API does not make use of the JSON key/value records as the other APIs do.

Security is enforced by requiring password authentication when an administrator password has been set. If an incorrect or no password is appended to the GET when one is needed, the command will be ignored.

The URLs for each of the commands and their effects are listed below:

Command URL List

URL

Impact

/api/control/clear

Clears the display of all posts.

/api/control/boot

Boots all connected users and deletes all posts on the display. Returns display to splash-screen.

/api/control/reboot

Reboots host as soon as command is sent.

/api/control/restart

Restarts the Solstice software without rebooting the hardware.

/api/control/resetkey

Replace the current screen key with a new random screen key for connection authentication.

/api/control/suspend

Goes into power management mode and suspends the display.

/api/control/wake

Wakes a suspended display.

Next Topic

Solstice Discovery Service (SDS) API