Get device summary information

Returns general device information:

• firmware version
• framework version
• API version
• device model type and name (some functionality may be unavailable on certain devices)
• device serial number
• Wi-Fi module presence

This endpoint is open and does not require authentication.

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• A Q07

---

Schema

• firmware_version string

  Firmware version

• framework_version string

  Framework version

• api_version string

  API version

• device_name string

  Device model name

• device_type string

  Possible values: [monitor, panel]

  Device type

• device_model string

  Possible values: [aq07, aq07l, aq07la, ak10, ak10l, am02, at07l, at10, at10l]

  Device model

• device_serial_number string

  Device serial number. Used with Link

• commit string

  Device commit.

• device_wifi string

  Possible values: [available, unavailable]

  Indicates whether a Wi-Fi module is physically present on the device. Devices without a Wi-Fi module will not support any /network/wifi/* endpoints.

{
  "firmware_version": "5.2.0",
  "framework_version": "1.6.0 20180713",
  "api_version": "2.0.0",
  "device_name": "AQ-07",
  "device_type": "monitor",
  "device_model": "aq07",
  "device_serial_number": "7f97370c-4fb1-4886-9e54-17c11a3e9399",
  "commit": "eb37ff1f5e9528b86eec7bff67705ffacaa1b3f7",
  "device_wifi": "available"
}

{
  "firmware_version": "5.11.0",
  "framework_version": "1.6.0 20180713",
  "api_version": "1.8.0",
  "device_name": "AQ-07",
  "device_type": "monitor",
  "device_model": "aq07",
  "device_serial_number": "7f97370c-4fb1-4886-9e54-17c11a3e9399",
  "device_wifi": "available"
}

Loading...