Skip to content
Documentation Prelude Collector 1.0.0

SNMP Browser API

Browse loaded MIB modules, explore OID trees, search MIB objects, and run on-demand SNMP walks against devices through the Prelude Collector REST API.

The SNMP Browser API exposes the Prelude Collector's loaded MIB catalog and lets you walk a device on demand. After this first mention, the rest of this page refers to Prelude Collector as "the collector". The browser is read-only against the MIB catalog, but the walk endpoint actively queries a device. This page covers when to reach for which endpoint, common mistakes, and a worked example. For the full endpoint schema, see the API reference.

When to use this API

  • Discovering what's collectible. Browse MIB modules, list OID children, and inspect table columns to figure out which OIDs to add to a model mapping.
  • Resolving an OID you saw in a packet capture. The OID detail endpoint returns name, syntax, access, status, and description so you can identify what a numeric OID actually represents.
  • Validating a walk profile. Walk profiles bundle the OIDs the collector pulls per NetOS — list them filtered by NetOS to see what is in scope.
  • Spot-checking a real device. The walk endpoint runs an on-demand SNMP walk or get against a device that already has an enabled SNMP protocol record.

Common pitfalls

  • Searching with too short a query. The search endpoint requires at least two characters and caps results.
  • Walking from a non-table OID. A walk that targets a scalar returns one row, not many — that is by design, not a bug.
  • Forgetting the device prerequisite. The walk endpoint requires the target device to have an enabled SNMP protocol record. Add one with the Protocols API first.
  • Dotted vs symbolic OIDs. Endpoints accept dotted numeric OIDs (for example 1.3.6.1.2.1.2.2.1.2). If you have a symbolic name, search for it first to find the numeric form.

Worked example: from search to walk

This flow searches the catalog for high-capacity counters, picks the OID, and walks it against a real device.

# 1. Find candidate OIDs.
curl -H "Authorization: Bearer <your-api-token>" \
  "https://collector.example.com/api/v1/snmp/mibs/search?query=ifHC&module=IF-MIB"

# 2. Inspect the OID detail (replace with the OID returned above).
curl -H "Authorization: Bearer <your-api-token>" \
  "https://collector.example.com/api/v1/snmp/mibs/oids?oid=1.3.6.1.2.1.31.1.1.1.6"

# 3. Walk that OID against device 1.
curl -X POST -H "Authorization: Bearer <your-api-token>" \
  -H "Content-Type: application/json" \
  -d '{"device-id":1,"oid":"1.3.6.1.2.1.31.1.1.1.6","mode":"walk","max-results":50}' \
  https://collector.example.com/api/v1/snmp/mibs/walk

Bruno: 09 SNMP Browser / Search MIBs, 09 SNMP Browser / Get OID detail, 09 SNMP Browser / Walk OID

Use the walk results to confirm the OID is supported on the device, then plug it into a model mapping and start a subscription.

Reference

Module imports, table columns, walk-profile filters, and detailed walk options are in the Bruno collection.

See also

Filtering by: