Skip to main content
Version: 7.1

SNMP Operations

NetObserv SNMP exposes an HTTP API. This page describes the available endpoints.

POST /api/v1/snmp/apply-definitions​

This endpoint triggers a re-read of all definitions files. Utilizing the apply-definitions endpoint allows for zero-downtime reconfiguration of the collector's SNMP definitions. It uses the definition directory paths configured when the collector was started.

Optional Query Parameters​

force_rediscovery​

By default, when object group or object definitions relating to a configured device change, then the device is not rediscovered. When force_rediscovery is set to true, and there is a change to the object group or object definitions relating to a device, then the device will automatically be rediscovered.

  • Example
curl --location --request POST 'http://0.0.0.0:8080/api/v1/snmp/apply-definitions?force_rediscovery=true'
  • Valid Values
    • true, false
  • Default
    • false

POST /api/v1/snmp/rediscover-device​

This endpoint triggers a rediscovery of an identified device. Utilizing the rediscover-device endpoint allows device rediscovery while the collector is running.

Required Body Properties​

The body content type must be application/json and the following properties are required to identify the device that should be rediscovered:

  • ip
  • port

Example:

curl --location --request POST 'http://0.0.0.0:8080/api/v1/snmp/rediscover-device' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ip": "127.0.0.1",
    "port": 161
}'