DHD REST API

The DHD REST API comes with Firmware Version 9.1 & Web Apps version 2.0. It is meant to provide easy access to useful functionalities of the console and is designed primarily to write. Reading values is only possible for global labels. This is to prevent polling.

DHD REST API is restricted to an average of one request per second, but can handle bursts of up to 10 requests per second. After such a burst of e.g. 10 requests, you will have to wait 10 seconds before the server accepts any new calls. If you have a Burst of e.g. 5 requests, you will have to wait 5 seconds. During this 'grace period', the server will respond with code 423 (Locked).

REST API must be enabled in Toolbox, [Device Node] > Web Apps Tab, REST API checkbox.

Set a single global label

curl -L -X GET 'http://1.2.3.4/action/setgloballabel?ObjectID=1&Name=test'

Get a single global label

The response is the label value in plain text.

curl -L -X GET 'http://1.2.3.4/action/getgloballabel?ObjectID=1'

Reset a single global label to Toolbox default.

curl -L -X GET 'http://1.2.3.4/action/setgloballabel?ObjectID=1&Name='

Set a single channel label

curl -L -X GET 'http://1.2.3.4/action/setchannellabel?ObjectID=1&Name=test'

Reset a single channel label to Toolbox default.

curl -L -X GET 'http://1.2.3.4/action/setchannellabel?ObjectID=1&Name='

Upload a picture of file type .png. This function replaces an existing Resource File and can be used for picture elements within TFT views.

We're using form-data for transmission of the required parameters and file.

curl -L -X POST 'http://1.2.3.4/action/updatepic' -F 'ObjectID=1' -F 'file=@image.png'

Login a specific user on a virtual mixer.

curl -L -X GET 'http://1.2.3.4/action/login?Token=XXX-XXX-XXX&ObjectID=0'

Logout a any user on a virtual mixer with a valid user token.

curl -L -X GET 'http://1.2.3.4/action/logout?Token=XXX-XXX-XXX&ObjectID=0'

Load a mixer snapshot on the console.

curl -L -X GET 'http://1.2.3.4/action/loadmx?ObjectID=0&SnapshotID=1'

Load a channel snapshot on the console.

curl -L -X GET 'http://1.2.3.4/action/loadch?ObjectID=0&SnapshotID=1'

Upload a channel snapshot on the console. The channel snapshot can be downloaded using Snapshots App.

curl -L -X POST 'http://1.2.3.4/action/uploadchsnap' -F 'file=@ChannelSnap_1.sfp' -F 'SnapshotID=1'

To choose, what to backup or restore, we use tags. The following tags are allowed:

Download a backup of all or selected parameters of the device.

curl -L -X GET 'http://1.2.3.4/action/backup?Token=XXX-XXX-XXX&Tags=ALL' 

curl -L -X GET 'http://1.2.3.4/action/backup?Token=XXX-XXX-XXX&Tags=NETWORK,SNMP' 

Upload and restore a previously downloaded backup of all or selected parameters of the device

We're using form-data for transmission of the required parameters and file.

curl -L -X POST 'http://1.2.3.4/action/restore' -F 'file=@Backup.bin' -F 'Tags=ALL' -F 'Token=XXX-XXX-XXX'

curl -L -X POST 'http://1.2.3.4/action/restore' -F 'file=@Backup.bin' -F 'Tags=NETWORK,AES67CONFIG' -F 'Token=XXX-XXX-XXX'

The server will respond with a status 200 and a JSON object. The JSON object contains the received values such as some data required by DHD audio for debugging. If something on your request goes wrong, the JSON object will contain an Error entry.

If the server doesn't respond with status code 200:

• Status code 423 (Locked): the REST API is locked because of too many requests (more than 10 per minute)
• Status code 405 (Method Not Allowed):
  • check if REST API checkbox is enabled within Toolbox [Device Node] > Web Apps Tab