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

Get BGP state details for all VRFs

get
http://127.0.0.1:8080/bgp/state/allVrfs

Retrieves BGP (Border Gateway Protocol) operational state information across all VRFs (Virtual Routing and Forwarding instances) for a specified appliance. Returns neighbor state, session status, and routing statistics for each VRF 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

Data source selector. When true, retrieves cached data from Orchestrator 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

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
text/html

Updated about 11 hours ago

Did this page help you?