{"type":"api","title":"Create BGP Routes List","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/d2f02ba2-fd0d-3a26-bcc5-feafc8f24d17","info":{"title":"Monitoring and Troubleshooting","description":"Includes API operations for the following:\n- Real-time monitoring\n- Accessing statistics APIs and statistics bulk APIs\n- Retrieving device state\n- Managing alarms and events\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Real-Time Monitoring - BGP"],"description":"Get BGP routes list (Real Time)","operationId":"createBGPRoutesList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"prefix","in":"query","description":"IP prefix","schema":{"type":"string"}},{"name":"nexthop","in":"query","description":"Next hop","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"BGP routes list":{"description":"BGP routes list","value":{"data":[{"vdevice-name":"172.16.255.15","prefix":"10.20.24.0/24","origin":"origin-incomplete","as-path":"10007","weight":"0","vpn-id":"1","vdevice-host-name":"vm5","nexthop":"10.20.24.17","afi-safi":"vpnv4-unicast","path-id":"0","vdevice-dataKey":"172.16.255.15-1-vpnv4-unicast-10.20.24.0/24","metric":"0","local-pref":"100","lastupdated":1646989331657,"path-status":"valid"},{"vdevice-name":"172.16.255.15","prefix":"10.20.24.0/24","origin":"origin-incomplete","weight":"32768","vpn-id":"1","vdevice-host-name":"vm5","nexthop":"0.0.0.0","afi-safi":"vpnv4-unicast","path-id":"0","vdevice-dataKey":"172.16.255.15-1-vpnv4-unicast-10.20.24.0/24","metric":"0","local-pref":"100","lastupdated":1646989331694,"path-status":"bestpathvalid"},{"vdevice-name":"172.16.255.15","prefix":"172.16.255.117/32","origin":"origin-incomplete","as-path":"10007","weight":"0","vpn-id":"1","vdevice-host-name":"vm5","nexthop":"10.20.24.17","afi-safi":"vpnv4-unicast","path-id":"0","vdevice-dataKey":"172.16.255.15-1-vpnv4-unicast-172.16.255.117/32","metric":"0","local-pref":"100","lastupdated":1646989331735,"path-status":"bestpathvalid"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write","method":"get","path":"/device/bgp/routes"}}