Get device information

Allows clients to get hardware information about their device. Includes other information such as:

  • firmware version
  • device status
  • IP address
  • MAC address
  • enrollment status
  • enrollment code (only returned when called with admin role, otherwise "")
  • deployment display name (deprecated, use device version instead)
  • device version

Minimum role required: general. admin required to get enrollment code.

Example Response Body

{
  "hardwareId": "XF714R57B319605",
  "model": "hdl410",
  "firmwareVersion": "1.9.278056-0",
  "deviceStatus": "Ok",
  "hardwareComponents": [
    {
      "model": "ConnectModule2",
      "hardwareId": "XF714R57B319605"
    },
    {
      "model": "Bar",
      "hardwareId": "AAC277A0D026",
      "portNumber": 1
    },
    {
      "model": "Bar",
      "hardwareId": "AAC277A0D027",
      "portNumber": 2
    }
  ],
  "ipAddress": "10.0.0.1",
  "mac_address": "cd:ba:ea:fb:a9:b8",
  "enrollmentStatus": "enrolled",
  "enrollmentCode": "AAA-BBB-CCC",
  "deploymentDisplayName": "5.0",
  "deviceVersion": "5.0.123456"
}
Headers
string
required

Identifier for the integration application or service. This is intended for you to specify the name of your integration. Use this same value every time your integration calls into the Nureva device. There is no strict format as long as the value is limited to 500 characters. For example, "MyCompany Integration", "Power API", "SyncMaster", "Cloud Orchestrator", "Ultimate Audio Overlord" are all acceptable values.

string
required

Identifier for the integration version. This is intended for you to specify the version of your integration application or service. There is no strict format as long as the value is limited to 500 characters. For example, "1", "2.0", "1.5.2", "beta", "1.0.0-alpha", "1.0.0+20250102" are all acceptable values.

Responses

Language
Credentials
Header
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json