RESTful API for Cisco vManage
The Cisco vManage supports RESTful (Representational State Transfer) API, which provides calls for retrieving real-time and static information about the Cisco SD-WAN overlay network and the devices in the network and for uploading device configuration templates and other configuration-related information. Using the RESTful API, you can design a custom portal for interacting with Cisco vManage.

The Cisco vManage API documentation is provided as part of the vManage software, at the URL https://vmanage-ip-address/apidocs. (More accurately, the full URL includes the Cisco vManage port number, https://vmanage-ip-address:8443/apidocs.) vmanage-ip-address is the IP address of the vManage server.
API calls are provided for the following categories of operations:
-
Certificate Management
-
Configuration
-
Device and Device Inventory
-
Monitoring
-
Real-Time Monitoring
-
Troubleshooting Tools
For each group of API calls, click Show/Hide to list the individual calls and the URL for each call. Each call shows its response class, required parameters, and response messages (status codes).
Click Try It Out, to display the request URL for each API call and the format of the response body. The request URL consists of the Cisco vManage's URL, followed by /dataservice. For example, https://10.0.1.32:8443/dataservice/device/interface/statistics/ge0/0?deviceId=172.16.255.11
Below are a few examples of the URLs to use for API calls:
Requested Information |
API Call |
---|---|
List all network devices |
dataservice/device |
Health status of hardware device components, such as CPU, memory, fan, and power |
dataservice/device/hardware/environment?deviceId=system-ip-address |
Status of a device's transport interfaces |
dataservice/device/interface?deviceId=system-ip-address&port-type=transport |
Interface statistics, errors, and packet drops |
dataservice/device/interface?deviceId=system-ip-address |
DTLS/TLS control connection status |
dataservice/device/control/connections?deviceId=system-ip-address |
OMP peering |
dataservice/device/omp/peers?deviceId=system-ip-address |
BGP peering on the service side |
dataservice/device/bgp/neighbors?deviceId=system-ip-address |