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

Get BGP neighbor configuration for default VRF

get
http://127.0.0.1:8080/bgp/config/neighbor

Retrieves BGP (Border Gateway Protocol) neighbor configuration for the default VRF segment. Returns a map of configured BGP peers keyed by neighbor IP address. Data can be fetched from Orchestrator cache or directly from the appliance.

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 from the appliance.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 13 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 13 hours ago

Did this page help you?