HomeGuidesAPI Reference
API Reference

Get Azure VWAN VPN Connection BGP Peer Status

Retrieves the BGP peer status for Azure Virtual WAN VPN connections associated with an appliance. Returns status for all connections or filters by interface label or Azure VPN site 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').

string

Interface label ID to filter BGP peer status for a specific VPN connection. When omitted, returns status for all interface labels.

string

Azure VPN Site ID to filter BGP peer status for a specific VPN connection. When omitted, returns status for all sites.

Responses

204

No content. No connection status data is available for the specified appliance.

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