Cloud and interconnect services operated through Cisco Catalyst SD-WAN Manager: multicloud gateways and accounts, Multicloud Interconnect connectivity, entitlement and resource audit, service chaining and the data collection agent.
{
"openapi": "3.1.0",
"info": {
"title": "SD-WAN Services",
"description": "Includes API operations for managing SD-WAN services such as Cloud OnRamp for SaaS and MultiCloud",
"contact": {
"email": "vmanage@cisco.com"
},
"license": {
"name": "Commercial License",
"url": "https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html"
},
"version": "26.1.0+2026-01-06",
"x-provenance": {
"method": "harvested",
"authored_by": "Cisco Catalyst SD-WAN",
"harvested_by": "API Evangelist",
"harvested_on": "2026-08-19",
"first_party": true,
"provider_published": true,
"source_host": "pubhub.devnetcloud.com",
"note": "4,138 operations across 2,841 paths, published by Cisco as self-contained per-operation OpenAPI 3.1.0 fragments on the DevNet CDN and consolidated here into 13 documents. Ownership verified from info.contact vmanage@cisco.com and the Cisco license URL rather than from the fetch host."
},
"x-evidence": [
{
"type": "source",
"url": "https://pubhub.devnetcloud.com/media/cisco-catalyst-sd-wan-26-1-api-guide/docs/"
},
{
"type": "source",
"url": "https://developer.cisco.com/docs/sdwan/"
}
]
},
"servers": [
{
"url": "/dataservice"
}
],
"tags": [
{
"name": "Configuration - Multi Cloud"
},
{
"name": "Data Collection Agent"
},
{
"name": "Multicloud Interconnect - Accounts"
},
{
"name": "Multicloud Interconnect - Cloud Resource Management"
},
{
"name": "Multicloud Interconnect - Connectivity"
},
{
"name": "Multicloud Interconnect - Entitlement"
},
{
"name": "Multicloud Interconnect - Gateways"
},
{
"name": "Multicloud Interconnect - General"
},
{
"name": "Multicloud Interconnect - Global Settings"
},
{
"name": "Multicloud Interconnect - Monitoring"
},
{
"name": "Multicloud Interconnect - Resource Audit"
},
{
"name": "Multicloud Interconnect - Service Sw package types"
},
{
"name": "Multicloud Interconnect - Services"
},
{
"name": "Service Chain Mapping"
},
{
"name": "System - Cloud Service"
}
],
"paths": {
"/cloudservices/accesstoken": {
"get": {
"tags": [
"System - Cloud Service"
],
"operationId": "getAccessTokenforDevice",
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {}
}
}
}
}
},
"/cloudservices/authtoken": {
"post": {
"tags": [
"System - Cloud Service"
],
"description": "Get Azure token",
"operationId": "getAzureToken",
"requestBody": {
"content": {
"*/*": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "object"
},
"examples": {
"Telemetry state": {
"description": "Telemetry state",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/cloudservices/connect": {
"get": {
"tags": [
"System - Cloud Service"
],
"description": "Telemetry Opt In",
"operationId": "connect_SystemCloudService_2203",
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "object"
},
"examples": {
"Telemetry Opt In": {
"description": "Telemetry Opt In",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/cloudservices/credentials": {
"get": {
"tags": [
"System - Cloud Service"
],
"description": "Get cloud service credentials",
"operationId": "getCloudCredentials",
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "object"
},
"examples": {
"Cloud service credentials": {
"description": "Cloud service credentials",
"value": {
"clientId": "exampleClientId"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write"
},
"post": {
"tags": [
"System - Cloud Service"
],
"description": "Add cloud service credentials",
"operationId": "addCloudCredentials",
"requestBody": {
"description": "Cloud service credentials",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloud service credentials": {
"description": "Cloud service credentials",
"value": {
"clientId": "exampleClientId",
"clientsecret": "exampleClientSecret",
"cloudTenantId": "exampleCloudTenantId"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "dca,CXP-write,Cloud OnRamp-write"
}
},
"/cloudservices/devicecode": {
"post": {
"tags": [
"System - Cloud Service"
],
"description": "Get Azure device code",
"operationId": "getDeviceCode",
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "object"
},
"examples": {
"Telemetry state": {
"description": "Telemetry state",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/cloudservices/m365/preferredpath": {
"post": {
"tags": [
"System - Cloud Service"
],
"description": "Get vAnalytics Preferred Path for Office365 over time. The data can be filtered on time and other unique parameters based upon necessity and intended usage",
"operationId": "getO365PreferredPathFromVAnalytics",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"valueType": {
"type": "string",
"enum": [
"ARRAY",
"OBJECT",
"STRING",
"NUMBER",
"TRUE",
"FALSE",
"NULL"
]
}
}
}
}
}
},
"required": true
},
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {}
}
}
}
}
},
"/cloudservices/staging": {
"get": {
"tags": [
"System - Cloud Service"
],
"description": "Check if testbed or production",
"operationId": "isStaging",
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "object"
},
"examples": {
"Environment": {
"description": "Environment",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/cloudservices/telemetry": {
"get": {
"tags": [
"System - Cloud Service"
],
"description": "Get Telemetry state",
"operationId": "getTelemetryState",
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "object"
},
"examples": {
"Telemetry state": {
"description": "Telemetry state",
"value": [
{
"tenantId": "default",
"optIn": "true",
"geography": "north-america",
"feature_name": "webex-group",
"cloudTenantId": "113d24ba-139b-4dfe-a0eb-9a4e32d525a0",
"org_name": "my org name"
}
],
"$$ref": "#/components/examples/ComViptelaVmanageServerCloudservicesResponseExampleO365Telemetry"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "CXP-read,CXP-write,Settings-read,Settings-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/cloudservices/telemetry/optin": {
"put": {
"tags": [
"System - Cloud Service"
],
"description": "Telemetry Opt In",
"operationId": "optIn",
"requestBody": {
"content": {
"*/*": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "object"
},
"examples": {
"Telemetry Opt In": {
"description": "Telemetry Opt In",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/cloudservices/telemetry/optout": {
"delete": {
"tags": [
"System - Cloud Service"
],
"description": "Telemetry Opt Out",
"operationId": "optOut",
"requestBody": {
"content": {
"*/*": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "object"
},
"examples": {
"Telemetry Opt Out": {
"description": "Telemetry Opt Out",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-write,Template Deploy-write,CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/cloudservices/vanalytics/dashboardlist": {
"get": {
"tags": [
"System - Cloud Service"
],
"description": "Get vAnalytics Dashboard List",
"operationId": "getvAnalyticsDashboardList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"DCA access token": {
"description": "DCA access token",
"value": {
"body": [
{
"dashboardContainer": "monitor",
"dashboardName": "overview",
"displayName": "Overview",
"path": "/analytics/v4/overview",
"srcUrl": "analytics-us-stg01.sdwan.cisco.com"
},
{
"dashboardContainer": "Monitor",
"dashboardName": "applications",
"displayName": "Applications",
"path": "/analytics/v4/applications",
"srcUrl": "analytics-us-stg01.sdwan.cisco.com"
},
{
"dashboardContainer": "Monitor",
"dashboardName": "sites",
"displayName": "Sites",
"path": "/analytics/v4/sites",
"srcUrl": "analytics-us-stg01.sdwan.cisco.com"
}
]
},
"$$ref": "#/components/examples/ComViptelaVmanageServerCloudservicesResponseExampleVaDashboardList"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "vAnalytics-readvAnalytics-write"
}
},
"/dca/analytics": {
"put": {
"tags": [
"Data Collection Agent"
],
"description": "Update collection time of DCARest stat for vAnalytics",
"operationId": "createStats",
"requestBody": {
"description": "Stats query",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Stats query": {
"description": "Stats query",
"value": [
{
"tenantId": "15d42ac9-94d2-4c2b-bad1-4b7d5259ce84",
"stats": [
{
"statisticsName": "status",
"collectionTime": 1717158934
},
{
"statisticsName": "device",
"collectionTime": 1717158934
}
]
}
],
"$$ref": "#/components/examples/ComViptelaVmanageServerDcaRequestExampleDcaAnalytics"
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Stats data": {
"description": "Stats data",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/dca/analytics/all": {
"post": {
"tags": [
"Data Collection Agent"
],
"description": "Get all statistics setting data",
"operationId": "getAllStatsDataDCA",
"requestBody": {
"description": "Stats setting",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Stats query": {
"description": "Stats query",
"value": {
"tenantId": [
"15d42ac9-94d2-4c2b-bad1-4b7d5259ce84",
"84706b7c-6a71-4423-a55f-9bc069139e87"
]
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDcaRequestExampleDcaAnalyticsAll"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Stats index status": {
"description": "Stats index status",
"value": [
{
"statisticsName": "status",
"tenantId": "15d42ac9-94d2-4c2b-bad1-4b7d5259ce84",
"collectionTime": 1717155340,
"@rid": 4660
},
{
"statisticsName": "device",
"tenantId": "15d42ac9-94d2-4c2b-bad1-4b7d5259ce84",
"collectionTime": 1717157134,
"@rid": 4661
},
{
"statisticsName": "status",
"tenantId": "84706b7c-6a71-4423-a55f-9bc069139e87",
"collectionTime": 1717157437,
"@rid": 4662
},
{
"statisticsName": "device",
"tenantId": "84706b7c-6a71-4423-a55f-9bc069139e87",
"collectionTime": 1717155334,
"@rid": 4696
}
],
"$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleDcaAnalyticsAll"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/dca/cloudservices": {
"get": {
"tags": [
"System - Cloud Service"
],
"description": "Get cloud service settings",
"operationId": "getCloudSettings",
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "object"
},
"examples": {
"Cloud service setting": {
"description": "Cloud service setting",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "dca"
}
},
"/dca/cloudservices/accesstoken": {
"get": {
"tags": [
"Data Collection Agent"
],
"description": "Get DCA access token",
"operationId": "getAccessToken",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"DCA access token": {
"description": "DCA access token",
"value": {
"token": "token text",
"exp": 1717313731,
"sp_org_name": "my sp org name",
"cloud": "AWS",
"region": "Americas",
"vmonitor_url": "vmonitor.sdwan.cisco.com",
"dcs_url": "analytics.sdwan.cisco.com",
"iss": "urn:dms",
"iat": 1717140931,
"aud": "urn:vanalytics"
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleAccessToken"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Data Collection Agent"
],
"description": "Set DCA access token",
"operationId": "storeAccessToken",
"requestBody": {
"description": "DCA access token",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"DCA access token": {
"description": "DCA access token",
"value": {
"token": "token data",
"exp": 1717331845,
"sp_org_name": "my org name",
"cloud": "AWS",
"region": "Americas",
"vmonitor_url": "sdwan.cisco.com",
"dcs_url": "sdwan.cisco.com",
"iss": "urn:dms",
"iat": 1717159044,
"aud": "urn:vanalytics"
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDcaRequestExampleAccessToken"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/dca/cloudservices/alarm": {
"post": {
"tags": [
"Data Collection Agent"
],
"description": "Generate DCA alarms",
"operationId": "generateAlarm",
"requestBody": {
"description": "DCA alarm message",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"DCA alarm message": {
"description": "DCA alarm message",
"value": {
"type": "otp_expired",
"message": "Cloud service OTP expired"
}
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/dca/cloudservices/idtoken": {
"get": {
"tags": [
"Data Collection Agent"
],
"description": "Get DCA Id token",
"operationId": "getIdToken",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"DCA Id token": {
"description": "DCA Id token",
"value": {
"token": "token text",
"exp": 1717313731,
"sp_org_name": "my sp org name",
"cloud": "AWS",
"region": "Americas",
"vmonitor_url": "vmonitor.sdwan.cisco.com",
"dcs_url": "analytics.sdwan.cisco.com",
"iss": "urn:dms",
"iat": 1717140931,
"aud": "urn:vanalytics"
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleIdToken"
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
},
"post": {
"tags": [
"Data Collection Agent"
],
"description": "Set DCA Id token",
"operationId": "storeIdToken",
"requestBody": {
"description": "DCA Id token",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"DCA Id token": {
"description": "DCA Id token",
"value": {
"token": "token data",
"sp_org_name": "VMANAGE",
"cloud": "AWS",
"region": "Americas",
"vmonitor_url": "sdwan.cisco.com",
"dcs_url": "sdwan.cisco.com",
"exp": 1717180644,
"iss": "urn:dms",
"iat": 1717159044,
"aud": "urn:vanalytics"
},
"$$ref": "#/components/examples/ComViptelaVmanageServerDcaRequestExampleIdToken"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/dca/cloudservices/otp": {
"get": {
"tags": [
"System - Cloud Service"
],
"description": "Get cloud service OTP value",
"operationId": "getOTP",
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "object"
},
"examples": {
"Cloud service OTP value": {
"description": "Cloud service OTP value",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "dca"
},
"put": {
"tags": [
"System - Cloud Service"
],
"description": "Update cloud service OTP value",
"operationId": "updatetOTP",
"requestBody": {
"description": "Cloud service OTP value",
"content": {
"application/octet-stream": {
"schema": {
"type": "object"
},
"examples": {
"Cloud service OTP value": {
"description": "Cloud service OTP value",
"value": {}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "dca"
}
},
"/dca/cloudservices/telemetry": {
"get": {
"tags": [
"Data Collection Agent"
],
"description": "Get DCA telemetry settings",
"operationId": "getTelemetrySettings",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"DCA telemetry settings": {
"description": "DCA telemetry settings",
"value": [
{
"tenantId": "default",
"optIn": "true",
"geography": "north-america",
"feature_name": "webex-group",
"cloudTenantId": "443d24ba-
# --- truncated at 32 KB (917 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-catalyst-sdwan/refs/heads/main/openapi/cisco-catalyst-sdwan-sd-wan-services-openapi.json