v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Network Device Monitoring

Get the list of interfaces of the device

Get the list of interfaces of the device.

get/api/v2/ndm/interfaces

Query parameters

device_idstring required

The ID of the device to get interfaces from.

get_ip_addressesboolean

Whether to get the IP addresses of the interfaces.

Response

Example response

{
  "data": [
    {
      "attributes": {
        "alias": "interface_0",
        "description": "a network interface",
        "ip_addresses": [
          "1.1.1.1",
          "1.1.1.2"
        ],
        "mac_address": "00:00:00:00:00:00",
        "name": "if0",
        "status": "up"
      },
      "id": "example:1.2.3.4:99"
    }
  ]
}