Get Device Info

Retrieves information about the appliance. Use the Device ID value from the _id property to reference the device in subsequent API calls.

Authorizations: Administrator, Operator, Observer

Requests

^{GET /api/devices
cookie: sessionID: [Session ID]}

Parameters

N/A

Response

^{[
{
  "_id": "[Device ID]",
  "type": "gateway",
  "ip": "127.0.0.1",
  "name": "Haivision Gateway",
  "lastConnectedAt": [Date/time shown 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,
  "pendingSync": false,
  "lastConnection": "<1m"
}
]}

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.
statusCode	string	Device status code: warn, error, ok, or unknown.
status	string	Device status: Online, Device error, Offline, Never, or Communication error.
statusDetails	string	Device status details.
serialNumber	string	Device serial number.
firmware	string	Device firmware version.
hasAdminError	Boolean	Indicates if device has an error.
pendingSync	Boolean	Indicates if there is a device pending a sync task.
lastConnection	string	Last time connected to the device in string format (e.g., "<1m").