Get Device Configuration

Retrieves the configuration of the device, including the list of routes. The Device ID used in the command is retrieved via the Get Device Info command.

Authorizations: Administrator, Operator, Observer

Requests

GET /api/devices/[Device ID]
cookie: sessionID: [Session ID]

Parameters

N/A

Response

Note

Use the config > routes > id properties on subsequent API calls to start/stop the corresponding routes, as shown in Start or Stop Routes and Destinations.

{
  "_id": "[Device ID]",
  "type": "gateway",
  "ip": "127.0.0.1",
  "name": "Haivision Media Gateway",
  "lastConnectedAt": [Date/time in Unix time],
  "lastConfigReadAt": [Date/time in Unix time],
  "statusCode": "ok",
  "status": "Online",
  "statusDetails": "Connection has been established in the last 1 minutes.",
  "serialNumber": null,
  "firmware": "5.0.180611.1530",
  "hasAdminError": false,
  "config": {
    "routes": [ { <Route Object> } ],
    "settings": {
      "networkAdapters": [
        {
          "name": "eth0",
          "address": "10.67.12.128"
        },
        {
          "name": "idrac",
          "address": "169.254.0.2"
        }
      ]
    },
    "calypsos": [
      {
        "id": "Lh5ZNDm7LspsseJ3pg82jw",
        "gatewayName": "MG 141",
        "address": "dev.haivision.com",
        "httpPort": 80,
        "httpsPort": 443,
        "passcode": "[Pairing passcode]",
        "lastConnectedAt": 1536759437398,
        "status": "accepted",
        "statusDetails": "pairing accepted",
        "proxyAddress": "10.69.12.141",
        "proxyHttpPort": 80,
        "proxyHttpsPort": 443,
        "lastConnection": "<1m"
      }
    ]
  },
  "pendingSync": false,
  "lastAcceptedUpdate": 1530219677119,
  "lastConnection": "<1m",
  "gateway": {
    "port": 1080
  },
  "suggestedPollingInterval": {
    "ms": 10000
  }
}

Name	Type	Description
_id	string	Device ID.
type	string	Device type.
ip	string	IP address of the device. Note The IP address is from the front end to the backend, so 127.0.0.1 is expected.
name	string	Name of device.
lastConnectedAt	number	Last time connected to the device in Unix time.
lastConfigReadAt	number	Last time a read config occurred in Unix time.
statusCode	string	Device status code.
status	string	Device status: Online, Device error, Offline, Never, or Communication error.
statusDetails	string	Device status details: warn, error, ok, or unknown.
serialNumber	string	Device serial number.
firmware	string	Device firmware version.
hasAdminError	Boolean	Indicates if device has an error.
config	object	Device configuration object, including route objects (see Route Object Model for definition), networkAdapters objects (see following), and calypsos object (see following).
pendingSync	Boolean	Indicates if there is a device pending a sync task.
lastAcceptedUpdate	number	Last time a device update was accepted.
lastConnection	string	Last time connected to the device in string format (e.g., "<1m").
gateway	object	Gateway device settings: port number.
suggestedPollingInterval	object	Suggested polling device interval setting. Value in milliseconds.

NetworkAdapters Object Model

Name	Type	Destination
name	string	Adapter name.
address	string	IP address of network adapter.

Calypsos Object Model

Name	Type	Destination
address	string	IP address of paired HMP.
gatewayName	string	Gateway name in the relationship
httpPort	number	HTTP port of paired HMP.
httpsPort	number	HTTPS port of paired HMP.
id	string	HMP relationship ID.
lastConnectedAt	number	Last connected time.
lastConnection	string	Last connection string.
passcode	string	Pairing passcode.
proxyAddress	string	Proxy address.
proxyHttpPort	number	Proxy HTTP port.
proxyHttpsPort	number	Proxy HTTPS port.
status	string	Relationship status: accepted, pair pending, pairing error, pairing timeout, pairing denied, poll timeout, or poll error.
statusDetails	string	Relationship status detail.