REST API Reference

This API command reference lists and describes the available resources for the Haivision Media Gateway/SRT Gateway REST API. This is a list of API endpoints that can be used to create and manage stream routes on your HMG/HSG.

Note

Version 4.2 added additional endpoints for the new website UI workflow. These endpoints are labeled as ‘v2’ in their page titles.
The workflow used in previous Gateway versions is still available using the REST API. These endpoints are grouped under the Legacy tab below.

Login and Device

REST API Endpoint	Method	Use to…
`/api/session`	GET POST DELETE	Get Session Information Initiate Session Delete Existing Session
`/api/devices`	GET	Get Device Info
`/api/devices/[Device ID]`	GET	Get Device Configuration
`/api/tags`	GET	Get Device Tags

Routes

REST API Endpoint	Method	Use to…
`/api/routes`	GET POST	Get List of Routes (v2) Create a Route (v2)
`/api/routes/[Route ID]`	GET POST DELETE	Get Route Configuration (v2) Update a Route (v2) Delete a Route (v2)
`/api/routes/[Route ID]/actions`	PUT	Start or Stop Routes (v2)
`/api/system/preset`	GET POST	Export System Preset (v2) Import System Preset (v2)
`/api/routes/[Route ID]/thumbnail`	GET	Get Route Thumbnail

Sources

REST API Endpoint	Method	Use to…
`/api/sources`	GET POST	Get List of Sources Create a Source
`/api/sources/[Source ID]`	PUT DELETE	Update a Source Delete a Source

Destinations

REST API Endpoint	Method	Use to…
`/api/destinations`	GET POST	Get List of Destinations Create a Destination
`/api/destinations/[Destinations ID]`	PUT DELETE	Update a Destination Delete a Destination
`/api/routes/[Route ID]/destinations/[Destinations ID]/actions`	PUT	Start or Stop Destinations

Statistics

REST API Endpoint	Method	Use to…
`/api/statistics?routeID=[Route ID]`	GET	Get Route Statistics (v2)
`/api/statistics/srt?routeID=[Route ID]`	GET	Download Route Statistics (v2)
`/api/gateway/[Device ID]/statistics?routeID=[Route ID]&sourceID=[Source ID]`	GET	Get Source Statistics
`/api/gateway/[Device ID]/statistics?routeID=[Route ID]&destinationID=[Destination ID]`	GET	Get Destination Statistics
`/api/gateway/[Device ID]/statistics/client?routeID=[Route ID]&destinationID=` `[Destination ID]&clientAddress=[Client Address]&clientPort=[Client Port]`	GET	Get SRT Client Statistics

Legacy

REST API Endpoint	Method	Use to…
`/api/gateway/[Device ID]/routes`	GET	Get List of Routes
`/api/gateway/[Device ID]/routes/[Route ID]`	GET	Get Route Configuration
`/api/gateway/[Device ID]/updates`	POST	Create a Route, Update a Route, and Delete a Route
`/api/gateway/[Device ID]/commands`	POST	Start or Stop Routes and Destinations
`/api/gateway/[Device ID]/system/preset`	GET POST	Export System Preset Import System Preset
`/api/gateway/[Device ID]/statistics?routeID=[Route ID]`	GET	Get Route Statistics
`/api/gateway/[Device ID]/statistics/srt?routeID=[Route ID]`	GET	Download Route Statistics