Here you will find documentation about each endpoint in NAVs API.
On some endpoints you can do searches. This is done by using the search parameter:
api/netbox?search=some-sw
The list of fields used in the search are defined for each endpoint. Searches are case-insensitive and do partial matches.
Almost all endpoints supports filtering. This is done by specifying a value for the field you want to filter on:
api/netbox?room=a-room
api/netbox?category=GSW
Provides access to NAVs alert status. This is the same as viewing NAV status
Search: | None |
---|---|
Filters: | event_type, not_event_type, organization, not_organization, category, not_category, alert_type, not_alert_type, device_group, not_device_group |
Additional parameters: | |
|
Provides access to NAVs ARP data
Search: | None |
---|---|
Filters: | ip, mac, netbox, prefix |
Additional parameters: | |
|
Provides access to NAVs CAM data
Search: | None |
---|---|
Filters: | mac, netbox, ifindex, port |
Additional parameters: | |
|
Provides access to NAVs interface data
Search: | ifalias, ifdescr, ifname |
---|---|
Filters: | ifname, ifindex, ifoperstatus, netbox, trunk, ifadminstatus, iftype, baseport |
Provides access to NAVs netbox data
Search: | sysname |
---|---|
Filters: | ip, sysname, room, organization, category |
Provides access to NAVs prefix data
Search: | None |
---|---|
Filters: | vlan, net_address, vlan__vlan Note The vlan__vlan is used to filter on vlan number as the vlan field references the primary key only. e.g. prefix?vlan__vlan=<vlan-number> |
List all prefixes that are routed
Search: | None |
---|---|
Filters: | None |
Additional parameters: | |
|
List usage statistics for prefixes. This fetches the number of active IP-addresses for each prefix and compares it to the number of possible addresses on each prefix. If no time interval is specified, fetches the current status
Search: | None |
---|---|
Filters: | None |
Additional parameters: | |
|
Provide access to NAVs unrecognized neighbor data.
Search: | remote_name |
---|---|
Filters: | netbox, source |