Introduction
SD-WAN Manager API
Section titled “SD-WAN Manager API”Cisco Catalyst SD-WAN Manager API is a Representational State Transfer Application Programming Interface (REST API) for controlling, configuring, and monitoring the Cisco devices in an overlay network.
The API plays a pivotal role in enabling clients to utilize the features provided by Cisco Catalyst SD-WAN Manager.
Some of the use cases for Cisco Catalyst SD-WAN Manager API are:
- Provisioning: Streamline manual tasks with automation. APIs enable the automated provisioning of Cisco Catalyst SD-WAN overlays, eliminating the need for network administrators to manually configure routers, routing, security policies, or other SD-WAN features. Organizations can utilize provisioning platforms or automation tools, laying the groundwork for Network as Code.
- Network visibility: APIs enhance network visibility by allowing seamless integration with monitoring tools to collect and analyze network performance data. They provide insights into network traffic, device status, and potential issues, enabling proactive management and troubleshooting.
- Integration with third-Party tools: Enhance API integration with external network management and monitoring solutions to offer a more comprehensive view of the network environment.
- Network as Code: Leverages APIs from Cisco Catalyst SD-WAN Manager to automate network configuration and management, treating network infrastructure as programmable assets. This approach enables streamlined deployment, consistent configuration, and rapid adaptation to changes, enhancing efficiency and reducing errors.
API coverage by release
Section titled “API coverage by release”The table counts API operations in all 13 categories of the local OpenAPI specifications. Each HTTP method on a path counts as one operation, so GET /device and POST /device would count separately. These are specification counts, not the number of distinct URL paths.
| API category | 20.18 | 26.1 | 26.2 |
|---|---|---|---|
| Administration and Settings | 59 | 59 | 59 |
| Monitoring and Troubleshooting | 1,040 | 1,068 | 1,094 |
| SD-WAN Services | 180 | 180 | 125 |
| Partner Integrations | 87 | 76 | 77 |
| UX 1.0 Configuration | 862 | 862 | 825 |
| UX 2.0 Configuration | 39 | 39 | 39 |
| Feature Profiles: SD-WAN System | 73 | 73 | 73 |
| Feature Profiles: SD-WAN Transport | 224 | 224 | 239 |
| Feature Profiles: SD-WAN Service | 160 | 160 | 165 |
| Feature Profiles: Mobility and NFV | 137 | 137 | 137 |
| Feature Profiles: SD-Routing | 429 | 429 | 439 |
| Feature Profiles: Others | 111 | 113 | 128 |
| Others | 702 | 718 | 720 |
| Total API operations | 4,103 | 4,138 | 4,120 |
REST-API Payloads
Section titled “REST-API Payloads”Except for a few file upload APIs, most of the request payloads are in JSON format.
The response payload can be in one of the following formats:
“Legacy” APIs: header + data block in JSON - see below:
Legacy APIs - Get devices
{"header": { "generatedOn": 1775039399262, "viewKeys": { "uniqueKey": [ "system-ip" ], "preferenceKey": "grid-Device" }, "columns": [ { "title": "client.view.clientViewDevice.hostname", "property": "host-name", "display": "iconAndText", "iconProperty": "device-type", "hideable": false, "icon": [ { "key": "vmanage", "value": "images/vmanage_table.png" }, { "key": "vedge", "value": "images/vedge_table.png" }, { "key": "vedge-vbond", "value": "images/vedge-vbond_table.png" }, { "key": "vsmart", "value": "images/vsmart_table.png" }, { "key": "vbond", "value": "images/vbond_table.png" } ], "width": 150, "dataType": "string" }, { "title": "client.view.clientViewDevice.deviceModel", "property": "device-model", "display": "multiColumns", "hideable": false, "width": 100, "dataType": "deviceModel" }, { "title": "client.view.clientViewDevice.siteId", "property": "site-id", "hideable": false, "width": 70, "dataType": "numberStr" }, { "title": "client.view.clientViewDevice.siteName", "property": "site-name", "hideable": false, "width": 70, "dataType": "string" }, { "title": "client.view.clientViewDevice.systemIp", "property": "system-ip", "hideable": false, "width": 110, "dataType": "ipv4" }, { "title": "view.certificate.clientViewVedgeList.tags", "property": "tags", "hideable": true, "dataType": "string" }, { "title": "client.view.clientViewDevice.chassisNumber", "property": "uuid", "width": 220, "dataType": "string" }, { "title": "client.view.clientViewDevice.reachability", "property": "reachability", "display": "multiColumns", "color": [ { "key": "reachable", "value": "616161", "property": "reachability" }, { "key": "unreachable", "value": "ef5350", "property": "reachability" }, { "key": "auth-failed", "value": "ffb300", "property": "reachability" }, { "key": "staging", "value": "ffb300", "property": "validity" } ], "width": 150, "minWidth": 150, "dataType": "string" }, { "title": "client.view.clientViewDevice.state", "property": "state", "display": "iconAndToolTip", "iconProperty": "state", "toolTipProperty": "state_description", "defaultPropertyKey": "reachability", "defaultPropertyValue": "reachable", "icon": [ { "key": "green", "value": "images/device_state_green.png" }, { "key": "red", "value": "images/device_state_red.png" }, { "key": "yellow", "value": "images/device_state_yellow.png" }, { "key": "default", "value": "images/device_state_other.png" } ], "width": 20, "dataType": "string" }, { "title": "client.view.clientViewDevice.bfd", "property": "bfdSessions", "width": 75, "minWidth": 65, "dataType": "numberStr" }, { "title": "client.view.clientViewDevice.control", "property": "controlConnections", "width": 75, "minWidth": 65, "dataType": "numberStr" }, { "title": "client.view.clientViewDevice.version", "property": "version", "width": 150, "dataType": "string" }, { "title": "client.view.clientViewDevice.upSince", "property": "uptime-date", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "width": 200, "dataType": "date" }, { "title": "client.view.clientViewDevice.deviceGroups", "property": "device-groups", "width": 100, "dataType": "array" }, { "title": "Connected Manager", "property": "connectedVManages", "width": 500, "dataType": "array" } ], "fields": [ { "property": "host-name", "dataType": "string", "display": "iconAndText" }, { "property": "device-model", "dataType": "deviceModel", "display": "multiColumns" }, { "property": "site-id", "dataType": "numberStr" }, { "property": "site-name", "dataType": "string" }, { "property": "system-ip", "dataType": "ipv4" }, { "property": "tags", "dataType": "string" }, { "property": "uuid", "dataType": "string" }, { "property": "reachability", "dataType": "string", "display": "multiColumns" }, { "property": "state", "dataType": "string", "display": "iconAndToolTip" }, { "property": "bfdSessions", "dataType": "numberStr" }, { "property": "controlConnections", "dataType": "numberStr" }, { "property": "version", "dataType": "string" }, { "property": "uptime-date", "dataType": "date" }, { "property": "device-groups", "dataType": "array" }, { "property": "connectedVManages", "dataType": "array" }, { "property": "number-vsmart-peers", "dataType": "number" }, { "property": "board-serial", "dataType": "string" }, { "property": "lastupdated", "dataType": "date" } ]},"data": [ { "deviceId": "100.0.0.1", "system-ip": "100.0.0.1", "host-name": "Manager01", "reachability": "reachable", "status": "normal", "personality": "vmanage", "device-type": "vmanage", "device-groups": [ "No groups" ], "lastupdated": 1775038353691, "domain-id": "0", "board-serial": "71A9AF8450E7497DB397DDD044D40AD5", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "2b6e4bff-5c8a-47ee-aade-2edd4a96d08e", "controlConnections": "9", "device-model": "vmanage", "version": "26.1.0.04", "connectedVManages": [ "100.0.0.1" ], "site-id": "100", "latitude": "37.666684", "longitude": "-122.777023", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1773913108684, "statusOrder": 4, "device-os": "next", "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "100.0.0.1", "total_cpu_count": "10", "testbed_mode": false, "layoutLevel": 1, "site-name": "SITE_100" }, { "deviceId": "100.0.0.101", "system-ip": "100.0.0.101", "host-name": "Controller01", "reachability": "reachable", "status": "normal", "personality": "vsmart", "device-type": "vsmart", "device-groups": [ "No groups" ], "lastupdated": 1775035948842, "domain-id": "1", "board-serial": "C22CB8AA6A2C4D26A9138446BC7A4056", "certificate-validity": "Valid", "uuid": "9f7efa85-7a50-405b-8553-54780097b0d5", "controlConnections": "16", "device-model": "vsmart", "version": "26.1.0.04", "connectedVManages": [ "100.0.0.1" ], "site-id": "100", "ompPeers": "7", "latitude": "37.666684", "longitude": "-122.777023", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1773913065835, "statusOrder": 4, "device-os": "next", "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "100.0.0.101", "total_cpu_count": "2", "testbed_mode": false, "layoutLevel": 2, "site-name": "SITE_100" }, { "deviceId": "100.0.0.102", "system-ip": "100.0.0.102", "host-name": "Controller02", "reachability": "reachable", "status": "normal", "personality": "vsmart", "device-type": "vsmart", "device-groups": [ "No groups" ], "lastupdated": 1775035948742, "domain-id": "1", "board-serial": "8D496672CBF84A89AEF66078229181AA", "certificate-validity": "Valid", "uuid": "1d307dd8-3846-40c4-b67f-1a07f29a8f90", "controlConnections": "16", "device-model": "vsmart", "version": "26.1.0-147", "connectedVManages": [ "100.0.0.1" ], "site-id": "100", "ompPeers": "7", "latitude": "37.666684", "longitude": "-122.777023", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1773913119734, "statusOrder": 4, "device-os": "next", "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "100.0.0.102", "total_cpu_count": "2", "testbed_mode": false, "layoutLevel": 2, "site-name": "SITE_100" }, { "deviceId": "100.0.0.201", "system-ip": "100.0.0.201", "host-name": "Validator01", "reachability": "reachable", "status": "normal", "personality": "vbond", "device-type": "vbond", "device-groups": [ "No groups" ], "lastupdated": 1775038352429, "board-serial": "DD920BE8AE5A49F4B265F0C999C213B7", "certificate-validity": "Valid", "uuid": "4cfbba67-b9c1-45cb-8f11-42c479bcf1ee", "controlConnections": "12", "device-model": "vedge-cloud", "version": "26.1.0.04", "connectedVManages": [ "100.0.0.1" ], "site-id": "100", "ompPeers": "--", "latitude": "37.666684", "longitude": "-122.777023", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1773913064419, "statusOrder": 4, "device-os": "next", "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "100.0.0.201", "total_cpu_count": "2", "linux_cpu_count": "1", "testbed_mode": false, "layoutLevel": 3, "site-name": "SITE_100" }, { "deviceId": "10.0.0.1", "system-ip": "10.0.0.1", "host-name": "edge1-paris", "reachability": "reachable", "status": "normal", "personality": "vedge", "device-type": "vedge", "timezone": "UTC +0000", "device-groups": [ "No groups" ], "lastupdated": 1775035352933, "bfdSessionsUp": 10, "domain-id": "1", "board-serial": "A8D638F8", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "C8K-3D1A8960-6E76-532C-DA93-50626FC5797E", "bfdSessions": "10", "controlConnections": "5", "device-model": "vedge-C8000V", "version": "26.01.01.0.2", "connectedVManages": [ "100.0.0.1" ], "site-id": "201", "ompPeers": "2", "latitude": "48.8577", "longitude": "2.3518", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1773913212925, "statusOrder": 4, "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "10.0.0.1", "total_cpu_count": "4", "linux_cpu_count": "1", "testbed_mode": false, "layoutLevel": 4, "site-name": "SITE_201" }, { "deviceId": "10.0.0.2", "system-ip": "10.0.0.2", "host-name": "edge2-nice", "reachability": "reachable", "status": "normal", "personality": "vedge", "device-type": "vedge", "timezone": "UTC +0000", "device-groups": [ "No groups" ], "lastupdated": 1775035352224, "bfdSessionsUp": 10, "domain-id": "1", "board-serial": "1D3F33E1", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "C8K-D4CE7174-5261-7E6F-91EA-4926BCF4C2DD", "bfdSessions": "10", "controlConnections": "5", "device-model": "vedge-C8000V", "version": "26.01.01.0.2", "connectedVManages": [ "100.0.0.1" ], "site-id": "202", "ompPeers": "2", "latitude": "43.7102", "longitude": "7.262", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1773913217216, "statusOrder": 4, "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "10.0.0.2", "total_cpu_count": "4", "linux_cpu_count": "1", "testbed_mode": false, "layoutLevel": 4, "site-name": "SITE_202" }, { "deviceId": "10.0.0.3", "system-ip": "10.0.0.3", "host-name": "edge3-barcelona", "reachability": "reachable", "status": "normal", "personality": "vedge", "device-type": "vedge", "timezone": "UTC +0000", "device-groups": [ "No groups" ], "lastupdated": 1775035353136, "bfdSessionsUp": 10, "domain-id": "1", "board-serial": "17052BF9", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "C8K-27148AFE-7160-69D3-ACC5-F77560530D63", "bfdSessions": "10", "controlConnections": "5", "device-model": "vedge-C8000V", "version": "17.15.02a.0.179", "connectedVManages": [ "100.0.0.1" ], "site-id": "301", "ompPeers": "2", "latitude": "41.3851", "longitude": "2.16559", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1773913226128, "statusOrder": 4, "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "10.0.0.3", "total_cpu_count": "4", "linux_cpu_count": "1", "testbed_mode": false, "layoutLevel": 4, "site-name": "SITE_301" }, { "deviceId": "10.0.0.5", "system-ip": "10.0.0.5", "host-name": "edge5-rome", "reachability": "reachable", "status": "normal", "personality": "vedge", "device-type": "vedge", "timezone": "UTC +0000", "device-groups": [ "No groups" ], "lastupdated": 1775035350965, "bfdSessionsUp": 10, "domain-id": "1", "board-serial": "42BF9ED1", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "C8K-5BAF9C99-7676-401F-9DFE-B1A3BEBD644B", "bfdSessions": "10", "controlConnections": "5", "device-model": "vedge-C8000V", "version": "17.18.02.0.4112", "connectedVManages": [ "100.0.0.1" ], "site-id": "401", "ompPeers": "2", "latitude": "41.89718", "longitude": "12.4817", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1773913190955, "statusOrder": 4, "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "10.0.0.5", "total_cpu_count": "4", "linux_cpu_count": "1", "testbed_mode": false, "layoutLevel": 4, "site-name": "SITE_401" }, { "deviceId": "10.0.0.7", "system-ip": "10.0.0.7", "host-name": "edge7-stuttgart", "reachability": "reachable", "status": "normal", "personality": "vedge", "device-type": "vedge", "timezone": "UTC +0000", "device-groups": [ "No groups" ], "lastupdated": 1775035352207, "bfdSessionsUp": 10, "domain-id": "1", "board-serial": "A24B78AC", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "C8K-3188FA44-8A8A-8392-0E4B-0DA5A445C10B", "bfdSessions": "10", "controlConnections": "5", "device-model": "vedge-C8000V", "version": "17.18.02.0.4112", "connectedVManages": [ "100.0.0.1" ], "site-id": "501", "ompPeers": "2", "latitude": "48.776", "longitude": "9.1816", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1773913213200, "statusOrder": 4, "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "10.0.0.7", "total_cpu_count": "4", "linux_cpu_count": "1", "testbed_mode": false, "layoutLevel": 4, "site-name": "SITE_501" }, { "deviceId": "10.0.0.8", "system-ip": "10.0.0.8", "host-name": "edge8-munich", "reachability": "reachable", "status": "normal", "personality": "vedge", "device-type": "vedge", "timezone": "UTC +0000", "device-groups": [ "No groups" ], "lastupdated": 1775035351071, "bfdSessionsUp": 10, "domain-id": "1", "board-serial": "44C6E493", "certificate-validity": "Valid", "max-controllers": "0", "uuid": "C8K-3A3DD488-D04F-3204-90F5-2E754FD14877", "bfdSessions": "10", "controlConnections": "5", "device-model": "vedge-C8000V", "version": "17.18.02.0.4112", "connectedVManages": [ "100.0.0.1" ], "site-id": "502", "ompPeers": "2", "latitude": "48.1349", "longitude": "11.5799", "isDeviceGeoData": false, "platform": "x86_64", "uptime-date": 1773913205065, "statusOrder": 4, "validity": "valid", "state": "green", "state_description": "All daemons up", "model_sku": "None", "local-system-ip": "10.0.0.8", "total_cpu_count": "4", "linux_cpu_count": "1", "testbed_mode": false, "layoutLevel": 4, "site-name": "SITE_502" }]}New APIs: data-only block (new APIs)
New APIs - Get Config Groups
[{ "id": "d18aa21f-b507-4018-8237-21f4031fffd5", "name": "edge_basic", "description": "Do not modify!", "source": null, "solution": "sdwan", "lastUpdatedBy": "admin", "lastUpdatedOn": 1773822086456, "createdBy": null, "createdOn": null, "profiles": [ { "id": "885c06aa-a91e-434a-935f-f4e1e2cc2936", "name": "Default_Policy_Object_Profile", "solution": "sdwan", "type": "policy-object", "description": null, "lastUpdatedBy": "system", "lastUpdatedOn": 1773913340284, "createdBy": "system", "createdOn": 1748854249992, "profileParcelCount": 27, "origin": null }, { "id": "8394f943-d5c9-40ef-a0f6-e96f710cb931", "name": "edge_basic_system", "solution": "sdwan", "type": "system", "description": null, "lastUpdatedBy": "system", "lastUpdatedOn": 1773822371925, "createdBy": "admin", "createdOn": 1748854537171, "profileParcelCount": 6, "origin": null }, { "id": "ef5be1a2-92f9-497b-86b3-2a638933cefd", "name": "edge_basic_wan", "solution": "sdwan", "type": "transport", "description": null, "lastUpdatedBy": "admin", "lastUpdatedOn": 1768489244844, "createdBy": "admin", "createdOn": 1748854528583, "profileParcelCount": 3, "origin": null }, { "id": "33ceb1db-350a-41cc-b062-634ed408707c", "name": "edge_basic_lan", "solution": "sdwan", "type": "service", "description": null, "lastUpdatedBy": "admin", "lastUpdatedOn": 1768489244844, "createdBy": "admin", "createdOn": 1748854533031, "profileParcelCount": 3, "origin": null }, { "id": "fc406fb1-1c11-408d-9d74-95f695821576", "name": "edge_basic_cli", "solution": "sdwan", "type": "cli", "description": null, "lastUpdatedBy": "admin", "lastUpdatedOn": 1768489244844, "createdBy": "admin", "createdOn": 1748854526488, "profileParcelCount": 1, "origin": null } ], "version": 2, "state": null, "devices": [], "numberOfDevices": 0, "numberOfDevicesUpToDate": 0, "origin": "user", "copyInfo": null, "originInfo": null, "topology": null, "fullConfigCli": false, "iosConfigCli": false, "versionIncrementReason": null, "insecureConfigCount": 0}]