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

Get OSPF neighbors state for all VRF segments

get
http://127.0.0.1:8080/ospf/state/allVrfs/neighbors

Retrieves the OSPF neighbor state information for all VRF segments on the specified appliance. Returns neighbor details including router ID, IP address, state, and interface information keyed by segment ID.

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 GMS database instead of querying the appliance directly. Defaults to false.

Responses

401

Unauthorized. Authentication required or invalid credentials.

403

Forbidden. User lacks READ or READ_WRITE permission.

Updated about 11 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

Updated about 11 hours ago

Did this page help you?