dev
  • Contents
      • NAV documentation
        • Getting help
        • First steps
        • Digging deeper
      • Overview
        • What it is
        • What NAV does
        • A brief history of NAV
      • Installing NAV
        • Installing a pre-packaged version of NAV
        • Installing NAV from source code
      • Getting started with NAV
        • Minimal configuration
        • Starting NAV
        • Logging in to the web interface
        • Seeding your database
        • Further reading
      • Getting organized
        • Organizing your seed data
        • Organizing your collected data
      • Howtos
        • Command line utilities provided in NAV
        • Installing NAV from source code
        • Install from source on Debian
        • Installing Graphite for use with NAV on Debian
        • Integrating Graphite with NAV
        • Migrating RRD data to Graphite (from NAV 3 to NAV 4)
        • Troubleshooting topology problems in NAV
        • Robustifying e-mail
        • Migrating data from one NAV installation to another
        • Authenticating with the apache plugin mod_auth_openidc and Feide
        • Controlling log output from NAV
        • The NAV API
        • NAV API Parameters
      • FAQ
        • Is vendor X / device Y supported?
        • Why are there gaps in my graphs?
        • Why does NAV list my device’s uplink as N/A?
        • Why doesn’t device X show as down in the status page when I know it’s down?
        • A device is down, I see it on the status page, my profile should cover the event, but I am not alerted. Why?
        • Why is my Cisco switch’ syslog full of SNMP-3-AUTHFAIL messages for requests from my NAV server?
        • I added a new IP Device using SeedDB, but nothing happens. Why?
        • How do I make NAV send SMS alerts?
        • How long are ARP and CAM records kept in the database?
      • Reference material
        • Management profiles
        • Arnold
        • Cabling and Patch
        • Event Engine
        • Event Templates
        • Event- and alert type hierarchy
        • Geomap
        • IPAM - IP Address Management
        • ipdevpoll
        • External authentication (LDAP, REMOTE_USER)
        • MailIn
        • navstats
        • PortAdmin
        • Radius
        • Setting up FreeRADIUS to log to NAV
        • smsd
        • snmptrapd
        • Backend processes in NAV
      • Network Administration Visualized release notes
        • NAV 5.8
        • NAV 5.7
        • NAV 5.6
        • NAV 5.5
        • NAV 5.4
        • NAV 5.3
        • NAV 5.2
        • NAV 5.1
        • NAV 5.0
        • NAV 4.9
        • NAV 4.8
        • NAV 4.7
        • NAV 4.6
        • NAV 4.5
        • NAV 4.4
        • NAV 4.3
        • NAV 4.2
        • NAV 4.1
        • NAV 4.0
        • NAV 3.15
        • NAV 3.14
        • NAV 3.13
        • NAV 3.12
        • NAV 3.11
        • NAV 3.10
        • NAV 3.9
        • NAV 3.8
      • Glossary
      • Hacking NAV
        • Hacker’s guide to NAV
        • Hacking with PyCharm
        • Using NAV with Docker for development
        • Javascript hacking
        • Checklist for releasing a new NAV version
        • Writing a new servicemon plugin
        • Adding support for a new environment probe device to NAV
        • The NAV API
        • Extending NAV locally
        • How to customize parts of NAV’s web interface
        • NAVbar search providers
        • Establishing SNMP tunnels using socat/SSH
  • Page
      • NAV API Parameters
        • Searches
        • Filters
        • Detailed endpoint specifications
          • api/alert/
          • api/arp/[<id>]
          • api/cam/[<id>]
          • api/interface/[<id>]
          • api/netbox/[<id>]
          • api/room/[<id>]
          • api/prefix/[<id>]
          • api/prefix/routed
          • api/prefix/usage/[<prefix>]
          • api/unrecognized-neighbors/[<id>]
  • « The NAV API
  • FAQ »
  • NAV API Parameters
    • Searches
    • Filters
    • Detailed endpoint specifications
      • api/alert/
      • api/arp/[<id>]
      • api/cam/[<id>]
      • api/interface/[<id>]
      • api/netbox/[<id>]
      • api/room/[<id>]
      • api/prefix/[<id>]
      • api/prefix/routed
      • api/prefix/usage/[<prefix>]
      • api/unrecognized-neighbors/[<id>]
Source

NAV API Parameters¶

Here you will find documentation about each endpoint in NAVs API.

Searches¶

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.

Filters¶

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

Detailed endpoint specifications¶

api/alert/¶

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

  • acknowledged=on - also list acknowledged alerts

  • on_maintenance=on - also list alerts regarding subjects on maintenance

  • stateless=on - also list stateless alerts (from the last 24 hours)

  • stateless_threshold=<hours> - adjust stateless interval

api/arp/[<id>]¶

Provides access to NAVs ARP data

Search

None

Filters

ip, mac, netbox, prefix

Additional parameters

  • active=on - list only entries that are active now (end_time = infinity)

api/cam/[<id>]¶

Provides access to NAVs CAM data

Search

None

Filters

mac, netbox, ifindex, port

Additional parameters

  • active=on - list only entries that are active now (end_time = infinity)

api/interface/[<id>]¶

Provides access to NAVs interface data

Search

ifalias, ifdescr, ifname

Filters

ifname, ifindex, ifoperstatus, netbox, trunk, ifadminstatus, iftype, baseport

api/netbox/[<id>]¶

Provides access to NAVs netbox data

Search

sysname

Filters

ip, sysname, room, organization, category

api/room/[<id>]¶

Provides access to NAVs room data

Search

None

Filters

location, description

api/prefix/[<id>]¶

Provides access to NAVs prefix data

Search

None

Filters

vlan, net_address, vlan__vlan, contains_address

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>

api/prefix/routed¶

List all prefixes that are routed

Search

None

Filters

None

Additional parameters

  • family=<4|6> - List only prefixes within the specified family

api/prefix/usage/[<prefix>]¶

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

  • start_time=<iso8601> - set start time

  • end_time=<iso8601> - set end time

api/unrecognized-neighbors/[<id>]¶

Provide access to NAVs unrecognized neighbor data.

Search

remote_name

Filters

netbox, source

Back to top

© Copyright 2012-2023 Uninett AS, 2022-2023 Sikt.
Created using Sphinx 4.4.0.