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

Get AWS VPN Connection BGP Peer Status

get
http://127.0.0.1:8080/thirdPartyServices/awstgnm/connectionStatus

Retrieves the BGP peer status for AWS VPN connections associated with a specific appliance. Returns connection status for WAN IPSEC and LAN GRE configurations including per-peer BGP state.

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. If omitted, returns status for all interface labels.

string

AWS Transit Gateway ID to filter BGP peer status for a specific Transit Gateway. If omitted, returns status for all associated Transit Gateways.

Responses

204

No connection status data available for the specified appliance or filters.

Updated about 12 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

Updated about 12 hours ago

Did this page help you?