HomeGuidesAPI Reference
API Reference

Get OSPF system state for all VRFs

Retrieves the current OSPF system state information for all VRF segments on the specified appliance. Returns routing protocol status, redistribution configuration state, LSA counters, and neighbor counts per segment.

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 OSPF state from the GMS database instead of querying the appliance directly. Useful for offline appliances or reducing load.

Responses

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