HomeGuidesAPI Reference
API Reference

Get OSPF interface state for all VRFs

Retrieves the current OSPF interface state across all VRF segments for the specified network element. Returns interface details including neighbor information, OSPF timers, designated routers, and interface configuration state. Data can be fetched directly from the appliance or from cached GMS 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 GMS database instead of querying the appliance directly. Useful for offline appliances or reducing appliance load.

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