/session

post

Login to the system with username and password, and get session id back id if success.

delete

Logs the current user out of the system, destroying the existing session, if any.

/system

get

Returns information about the Userful host.

get

Returns information about the license installed on the Userful host.

put

Claim the license for the Userful host using the given activation code. It can also be used to increase the number of displays for an existing license or replace the existing license using the new activation code.

delete

Delete license from the Userful host.

get

Download / Backup license.

put

Reboot the system.

put

Shutdown the system.

get

Get the manifest

get

Returns the status of broadcast message, whether the message is displayed or not.

put

Start broadcasting. Alert level can be GREEN_LEVEL, ORANGE_LEVEL and RED_LEVEL.

put

Stop broadcasting.

put

Show display id.

put

Hide display id.

get

Get the API log file.

get

Returns status about the Userful remote.

put

Start Userful Remote Control

delete

Stop Userful Remote Control.

get

Returns information about system diagnostics.

put

Wake monitors up from dpms sleep. (leave request body empty for all displays)

put

Put all monitors to dpms sleep. (leave request body empty for all displays)

get

Get a list of available 3rd party packages

post

Install specific packages

/presets

post

Create, update and save a preset.

get

Returns the list of existing presets.

get

Returns information about the preset specified by the given preset name.

delete

Delete a preset specified by the given preset name.

put

Switch between presets by giving the preset name.

get

Returns information about the preset specified by the given preset id.

delete

Delete a preset by giving a preset id.

put

Switch between presets by giving preset id.

/sources

get

Returns the source information.

post

Create source on the Userful host.

delete

Delete the specified source.

get

Get source information specified by giving source id.

delete

Remove source specified by giving source id.

put

Update configuration of the specific source like source name, scaling option.

/network

get

Returns the list of network devices connected to the Userful host. Network devices that are online but connected to another Userful host will not show up in this list.

get

Returns information about all the usb devices available on the network station.

get

Returns the information about the network device specified by giving the IP_Address.

put

Resets the network device specified by giving the IP_Address.

put

Lock a network device to the Userful host, thus changing the status to online in Control Center.

put

Unlock a network device from the Userful host, thus changing the status from online to available in Control Center.

/displays

get

Returns information about the displays.

get

Returns information about the display specified by giving the displayId.

put

Switch the display to other source.

put

Play the video list on the display.

put

Play the assigned source on the display.

put

Resets the display by giving the displayId. Regardless of type (On-board, USB, or Network), the specified display will reset by restarting X.

/zones

get

Returns the list of existing zones.

get

Returns information about the zone specified by giving zone name.

put

Change the zone name.

put

Switch the zone to other source.

put

Play the assigned source on the zone.

put

Play the video list on the zone specified by giving zoneId.

put

Stop the playing zone.

get

Returns information about the zone specified by the given videowallId.

get

Returns information about the zone specified by the given zoneId.

put

Switch the zone to other source.

put

Play the source assigned to the zone.

put

Play the video list.

put

Stop the playing zone.

/videowalls

get

Returns information about all the video walls for the Userful host.

get

Returns information about the videowall specified by the given videoWallId.

delete

Delete the videowall specified by the given videowallId.

/mirrorgroups

get

Returns information about all the mirror groups for the Userful host.

get

Returns information about the mirror groups specified by the given mirrorgroupName.

put

Play the given video list assigned to the mirror group.

put

Play the source assigned to the mirror group.

get

Returns information about the mirror groups specified by the given mirrorgroupId.

put

Play the video list assigned to the mirror group.

put

Play the source assigned to the mirror group.

/failover-group

get

Returns information about failover group which the current Userful host belongs to.

post

If the failover-group does not exist, create and join the failover-group. Or let the Userful host join an existing failover-group.

delete

Let the Userful host exit from the current failover-group. If there is only one Userful host in the group, the group will be deleted.