/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

post

submit a troubleshooting report

get

generate and download troubleshooting report (tar.bz2)

get

Returns the hostname

put

Update the hostname

get

Returns system's network interfaces

put

Update one of system's network interfaces

get

Check if host allows partner access through Cloud

put

Set host to allow or deny partner access through Cloud

get

Get receiver devices (zero clients) assignment settings. These settings affect the UCC Settings -> Reciever Device Configuration, see that panel for further notes about behavior.

put

Set receiver devices (zero clients) assignment settings. These settings affect the UCC Settings -> Reciever Device Configuration, see that panel for further notes about behavior.

get

Get the current and available time zones. These settings affect the UCC Settings -> Location, see that panel for further notes about behavior.

put

Set the current time zone. These settings affect the UCC Settings -> Location, see that panel for further notes about behavior.

get

(WARNING: ALPHA STATE, MAY CHANGE IN THE FUTURE)

Retrieves number that changes specifically if station assignment for mapping profiles are altered. For instance, if you configure the mapping page, and then call this API, if the number remains unchanged afterwards then the mapping page has not been altered.

Note that currently this functionality is only available current if failover groups are enabled and if the host is currently part of a failover group.

/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 receiver devices in the same network with the Userful host. Receiver devices with status "CONNECTED" are locked to this Userful host.

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. Source can be specified as request parameters (same as in version 1.3) or in request body

put

Play the video list on the display.

put

Play a specific source or the assigned source on the display (same as playAssignedSource in v1.2) if no sourceId/sourceName is specified

put

Pause the display if it is playing a video source

put

Resume the display if it was pause during playing a video source

put

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

put

Rewind the display by specified milliseconds if it is playing a signage source

put

Fast-forward the display by specified milliseconds if it is playing a signage source

put

Go to a specific play time on the display if it is playing a signage source

get

Get the playing current media info of the display if it is playing a signage source. '-1' totalDurationInMillliseconds means it's playing a non-signage source

get

Retrieve display's current and available resolutions.

put

Set the display's resolution.

get

Returns the current set tag on the given display. This is visible on an individual stand alone display in the mapping page.

put

Sets the tag on a display.

/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 (same as playAssignedSource in v1.2).

put

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

put

Stop the playing zone.

put

Resume the zone.

put

Pause the zone

put

Rewind the zone by specified milliseconds

put

Fast-forward the zone by specified milliseconds

put

Go to a specific play time on the zone

get

Get the current media info of the zone. '-1' totalDurationInMillliseconds means it's playing a non-signage source

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 (same as playAssignedSource in v1.2).

put

Play the video list.

put

Stop the playing zone.

put

Resume the zone.

put

Pause the zone

put

Rewind the zone by specified milliseconds

put

Fast-forward the zone by specified milliseconds

put

Go to a specific play time on the zone

get

Get the currnet media info of the zone. '-1' totalDurationInMillliseconds means it's playing a non-signage source

/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 a specific source or the assigned source on the mirror group (same as playAssignedSource in v1.2) if no sourceId/sourceName is specified

put

Pause the mirror group if it is playing a video source

put

Resume the mirror group if it was pause during playing a video source

put

Rewind the mirror group by specified milliseconds if it is playing a signage source

put

Fast-forward the mirror group by specified milliseconds if it is playing signage source

put

Go to a specific play time on the mirror group if it is playing signage source

get

Get the current media info of the mirror group if it is playing a signage source. '-1' totalDurationInMillliseconds means it's playing a non-signage source

get

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

put

Play the video list assigned to the mirror group.

put

Play a specific source or the assigned source on the mirror group (same as playAssignedSource in v1.2) if no sourceId/sourceName is specified

put

Pause the mirror group if it is playing a video source

put

Resume the mirror group if it was pause during playing a video source

put

Rewind the mirror group by specified milliseconds if it is playing a signage source

put

Fast-forward the mirror group by specified milliseconds if it is playing signage source

put

Go to a specific play time on the mirror group if it is playing signage source

get

Get the current media info of the mirror group if it is playing a signage source. '-1' totalDurationInMillliseconds means it's playing a non-signage source

/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. Both members of the group must be sent the same request in order to form a 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.

/failover-group-v2

get

Returns all failover settings

post

Setup failover on this system. This call fails if the system is already in a failover group. In most cases it is recommended to call /system/reboot after this call to ensure that the failover group has been activated.

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.

/failover-group-network-settings

get

Returns the current network settings used by failover, which includes network interface (blank means use system default), auto-discover peers, manually-set peer ip.

post

Specific network interface and peer discovery method. Call GET to see a list of available interfaces. Call PUT:/system/reboot afterward for the changes to take effect.

/printprofiles

post

update print profile with the same queue name or create new print profile

get

Returns list of print profiles.

get

Return print profiles with specified queue name

delete

delete print profiles with specified queue name

/serial/{seatID}

post

Send a serial command to a display defined by seatID

/controlroom

get

Returns all the configured control room video wall instances. Name in this case referes to the videowall zone names that been assigned to control room sources.

get

Gets all of the layouts for a given videowall zone that has been assigned to a Command and Control source.

get

Gets all of the layouts for a given videowall zone. If put in a zone that doens't exist or a zone that isn't assigned to a command and control source, then you will get a response with id as an empty string and name set to "None"

put

Loads a given layout as specified in the path.