HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. snmp

Get SNMP configuration for an appliance

get
http://127.0.0.1:8080/snmp

Retrieves the complete SNMP configuration for a specified appliance. Returns SNMP agent settings including system contact, location, description, trap configuration, access community strings, and SNMPv3 user settings. Data can be retrieved from cache or directly from the appliance.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

string
enum
Defaults to true

Controls data source. When 'true', returns cached data from Orchestrator database (faster). When 'false', fetches real-time data directly from the appliance and updates the cache. Defaults to 'true' if not specified.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 12 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/html

Updated about 12 hours ago

Did this page help you?