Skip to main content
Cisco SD-WAN
Support
Product Documentation
Viptela Documentation

BGP

API calls for real-time monitoring of BGP information:

Neighbors

List the router's BGP neighbors (on vEdge routers only).

CLI Equivalent: show bgp neighbor

URL: https://vmanage-ip-address/dataservice/device/bgp/neighbors?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
as Optional Autonomous system number Query String
peer-addr Optional Address of BGP peer Query String
vpn-id Optional ID of VPN Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Routes

List the router's BGP routes (on vEdge routers only).

CLI Equivalent: show bgp routes

URL: https://vmanage-ip-address/dataservice/device/bgp/routes?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
nexthop Optional Next hop Query String
prefix Optional IP Prefix Query String
vpn-id Optional ID of VPN Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Summary

Display the status of all BGP connections (on vEdge routers only).

CLI Equivalent: show bgp summary

URL: https://vmanage-ip-address/dataservice/device/bgp/summary?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Response Object for Real-Time Monitoring API Calls

The real-time monitoring API call responses have the following format:

{
  "header": {
    "generatedOn": timestamp, milliseconds (UNIX time format),                            
      "viewKeys": {
        "uniqueKey": ["key"]                       
      },
      "fields": [
        properties and types
      ],
   },
   "data": [
     array of objects
   ]
}

Additional Information

Using the vManage REST API

  • Was this article helpful?