v1
latestOpenAPI 3.0.02026-07-141,4077,1665.2 MBNetwork Device Monitoring
Get the list of devices
Get the list of devices.
get/api/v2/ndm/devices
Query parameters
page[size]integer
Example:50
Size for a given page. The maximum allowed value is 500. Defaults to 50.
page[number]integer
Specific page number to return. Defaults to 0.
sortstring
The field to sort the devices by. Defaults to name.
filter[tag]string
Filter devices by tag.
Response
OK
Example response
{
"data": [
{
"attributes": {
"description": "a device monitored with NDM",
"device_type": "other",
"integration": "snmp",
"interface_statuses": {
"down": 1,
"off": 2,
"up": 12,
"warning": 5
},
"ip_address": "1.2.3.4",
"location": "paris",
"model": "xx-123",
"name": "example device",
"os_name": "example OS",
"os_version": "1.0.2",
"ping_status": "unmonitored",
"product_name": "example device",
"serial_number": "X12345",
"status": "ok",
"subnet": "1.2.3.4/24",
"sys_object_id": "1.3.6.1.4.1.99999",
"tags": [
"device_ip:1.2.3.4",
"device_id:example:1.2.3.4"
],
"vendor": "example vendor",
"version": "1.2.3"
},
"id": "example:1.2.3.4"
}
],
"meta": {
"page": {
"total_filtered_count": 1
}
}
}