Type: JSON
Array of JSON objects that represent devices.
Device fields
| Name |
Type |
Nullable / Not nullable |
List of values |
| id |
Long integer |
Not nullable |
Device ID on the on-premises management console |
| sensorId |
Long integer |
Not nullable |
Device ID on the sensor |
| zoneId |
Long integer |
Not nullable |
The device's zone ID |
| siteId |
Long integer |
Not nullable |
The device's site ID |
| ipAddresses |
JSON array of strings |
Nullable |
JSON array of IP addresses. Each device can have multiple addresses in case of internet addresses or a device with multiple NICs. |
| name |
String |
Not nullable |
The device name. |
| type |
String |
Not nullable |
The device type. For more information see Supported type values. |
| macAddresses |
JSON array of strings |
Nullable |
JSON array of MAC addresses. Devices with multiple NICs can have multiple addresses. |
| operatingSystem |
String |
Nullable |
The device operating system. |
| engineeringStation |
Boolean |
Not nullable |
True or false |
| scanner |
Boolean |
Not nullable |
True or false |
| authorized |
Boolean |
Not nullable |
True or false |
| vendor |
String |
Nullable |
The device vendor. |
| Protocols |
JSON array |
Nullable |
JSON array of protocol objects. For more information, see Protocol fields. |
| firmware |
JSON array |
Nullable |
JSON array of firmware objects. For more information, see Firmware fields. |
Protocol fields
| Name |
Type |
Nullable / Not nullable |
List of values |
| Name |
String |
Not nullable |
The protocol name |
| Addresses |
JSON array of protocol addresses |
Not nullable |
Master, N/A, or a numeric representation of the protocol address |
Firmware fields
| Name |
Type |
Nullable / Not nullable |
List of values |
| serial |
String |
Not nullable |
N/A, or the firmware serial number |
| model |
String |
Not nullable |
N/A, or the firmware model |
| firmwareVersion |
Double |
Not nullable |
N/A, or the firmware version |
| additionalData |
String |
Not nullable |
N/A or additional, vendor-specific firmware data |
| moduleAddress |
String |
Not nullable |
N/A, or the firmware module address |
| rack |
String |
Not nullable |
N/A, or the firmware rack |
| slot |
String |
Not nullable |
N/A, or the firmware slot |
| address |
String |
Not nullable |
N/A, or the firmware address |
Response example
[
{
"sensorId": 7,
"zoneId": 1,
"siteId": 1,
"vendor": null,
"name": "10.4.14.102",
"firmware": [
{
"slot": "N/A",
"additionalData": "N/A",
"moduleAddress": "Network: Local network (0), Node: 0, Unit: CPU (0x0)",
"rack": "N/A",
"address": "10.4.14.102",
"model": "AAAAAAAAAA",
"serial": "N/A",
"firmwareVersion": "20.55"
},
{
"slot": "N/A",
"additionalData": "N/A",
"moduleAddress": "Network: Local network (0), Node: 0, Unit: Unknown (0x3)",
"rack": "N/A",
"address": "10.4.14.102",
"model": "AAAAAAAAAAAAAAAAAAAA",
"serial": "N/A",
"firmwareVersion": "20.55"
},
{
"slot": "N/A",
"additionalData": "N/A",
"moduleAddress": "Network: Local network (0), Node: 3, Unit: CPU (0x0)",
"rack": "N/A",
"address": "10.4.14.102",
"model": "AAAAAAAAAAAAAAAAAAAA",
"serial": "N/A",
"firmwareVersion": "20.55"
},
{
"slot": "N/A",
"additionalData": "N/A",
"moduleAddress": "Network: 3, Node: 0, Unit: CPU (0x0)",
"rack": "N/A",
"address": "10.4.14.102",
"model": "AAAAAAAAAAAAAAAAAAAA",
"serial": "N/A",
"firmwareVersion": "20.55"
}
],
"id": 79,
"macAddresses": null,
"authorized": true,
"ipAddresses": [
"10.4.14.102"
],
"engineeringStation": false,
"type": "PLC",
"operatingSystem": null,
"protocols": [
{
"addresses": [],
"id": 62,
"name": "Omron FINS"
}
],
"scanner": false
}
]