HomeGuidesAPI Reference
API Reference

Get OSPF Neighbor State

Retrieves the current state of OSPF neighbors for a specified appliance. Returns information about each OSPF neighbor including their adjacency state, router ID, designated router status, and timing parameters. Data can be fetched directly from the appliance or from the cached database.

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').

boolean
Defaults to false

When true, retrieves cached data from database. When false or omitted, fetches live data directly from the appliance.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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