searchOrgBgpStats

GET https://{{host}}/api/v1/orgs/:org_id/stats/bgp_peers/search

Response Body

NameTypeDescription
org_idstringrouter org ID
site_idstringrouter site ID
macstringrouter mac address
nodestringnode0/node1
timestamplongsampling time (in epoch)
local_asstringlocal AS
neighbor_asstringneighbor AS
vrf_namestringVRF name
neighborstringIP of neighbor
neighbor_macstringMac of neighbor
statestringidle, connect, active, opensent, openconfirm and established
upbooleantrue/false
tx_pktsinttx pkts
rx_pktsintrx pkts
rx_routesintnumber of received routes
tx_routesintnumber of sent routes
uptimeintuptime
for_overlaybooleantrue/false, if this is created for overlay
evpn_overlaybooleantrue/false, if this is created for evpn overlay

RESPONSES

status: OK

{"results":[{"org_id":"0c160b7f-1027-4cd1-923b-744534c4b070","site_id":"725a8d34-a126-4f2c-b990-d1219421cb75","mac":"020001c04668","node":"node0","timestamp":1666251056.07,"local_as":65000,"neighbor_as":65000,"vrf_name":"default","neighbor":"15.8.3.5","neighbor_mac":"020001e53153","uptime":31355,"up":true,"for_overlay":true,"state":"established","tx_pkts":1735,"rx_pkts":63366,"rx_routes":60,"tx_routes":60,"evpn_overlay":true}],"start":1619518689.4989705,"end":1619518989.4989712,"limit":10,"total":1}