The UX 1.0 (classic) configuration surface: device templates, feature templates, template attach/detach and the full policy builder — data, control, application-aware routing, security, voice and every policy list type.
{
"openapi": "3.1.0",
"info": {
"title": "UX 1.0 Configuration",
"description": "Configuration of UX 1.0 device and policy.\nIncludes API operations for the following:\n Managing original SD-WAN device configurations and policy configurations\n Device templates and feature templates",
"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 - Advanced Inspection Profile Definition"
},
{
"name": "Configuration - Azure Connect"
},
{
"name": "Configuration - Cloud On Ramp"
},
{
"name": "Configuration - CloudExpress"
},
{
"name": "Configuration - Device Template"
},
{
"name": "Configuration - FQDN List Builder"
},
{
"name": "Configuration - General Template"
},
{
"name": "Configuration - Ise Server"
},
{
"name": "Configuration - Policy AMP Definition Builder"
},
{
"name": "Configuration - Policy ASPath List Builder"
},
{
"name": "Configuration - Policy Access List Definition Builder"
},
{
"name": "Configuration - Policy App Probe Class List Builder"
},
{
"name": "Configuration - Policy AppRoute Definition Builder"
},
{
"name": "Configuration - Policy Application List Builder"
},
{
"name": "Configuration - Policy Cflowd Definition Builder"
},
{
"name": "Configuration - Policy Cloud Application Builder"
},
{
"name": "Configuration - Policy Color List Builder"
},
{
"name": "Configuration - Policy Community List Builder"
},
{
"name": "Configuration - Policy Control Definition Builder"
},
{
"name": "Configuration - Policy Custom Application Builder"
},
{
"name": "Configuration - Policy Data Definition Builder"
},
{
"name": "Configuration - Policy Data IPV6 Prefix List Builder"
},
{
"name": "Configuration - Policy Data Prefix All Types Of Lists Builder"
},
{
"name": "Configuration - Policy Data Prefix List Builder"
},
{
"name": "Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"
},
{
"name": "Configuration - Policy Device Access Definition Builder"
},
{
"name": "Configuration - Policy DialPeer Definition Builder"
},
{
"name": "Configuration - Policy Expanded Community List Builder"
},
{
"name": "Configuration - Policy Extended Community List Builder"
},
{
"name": "Configuration - Policy FXO Port Definition Builder"
},
{
"name": "Configuration - Policy FXS Port Definition Builder"
},
{
"name": "Configuration - Policy FXSDID Port Definition Builder"
},
{
"name": "Configuration - Policy Fax Protocol List Builder"
},
{
"name": "Configuration - Policy Forwarding Class List Builder"
},
{
"name": "Configuration - Policy Geo Location List Builder"
},
{
"name": "Configuration - Policy Hub and Spoke Definition Builder"
},
{
"name": "Configuration - Policy IPS Signature List Builder"
},
{
"name": "Configuration - Policy IPv6 Access Definition Builder"
},
{
"name": "Configuration - Policy IPv6 Device Access Definition Builder"
},
{
"name": "Configuration - Policy IPv6 Prefix List Builder"
},
{
"name": "Configuration - Policy Identity List Builder"
},
{
"name": "Configuration - Policy Intrusion Prevention Definition Builder"
},
{
"name": "Configuration - Policy List Builder"
},
{
"name": "Configuration - Policy Local Domain Definition Builder"
},
{
"name": "Configuration - Policy Local Domain Name List Builder"
},
{
"name": "Configuration - Policy Media Profile List Builder"
},
{
"name": "Configuration - Policy Mesh Definition Builder"
},
{
"name": "Configuration - Policy Mirror List Builder"
},
{
"name": "Configuration - Policy Modem Passthrough List Builder"
},
{
"name": "Configuration - Policy PRI ISDN Port Definition Builder"
},
{
"name": "Configuration - Policy Policer Class List Builder"
},
{
"name": "Configuration - Policy Port List Builder"
},
{
"name": "Configuration - Policy Prefix List Builder"
},
{
"name": "Configuration - Policy Prefix for All Types of Lists Builder"
},
{
"name": "Configuration - Policy Protocol Name List Builder"
},
{
"name": "Configuration - Policy Qos Map Definition Builder"
},
{
"name": "Configuration - Policy Region List Builder"
},
{
"name": "Configuration - Policy Rewrite Rule Definition Builder"
},
{
"name": "Configuration - Policy SLA Class List Builder"
},
{
"name": "Configuration - Policy Scalable Group Tag List Builder"
},
{
"name": "Configuration - Policy Security Assembler"
},
{
"name": "Configuration - Policy Site List Builder"
},
{
"name": "Configuration - Policy Supervisory Disc List Builder"
},
{
"name": "Configuration - Policy TLOC List Builder"
},
{
"name": "Configuration - Policy Threat Grid Api Key List"
},
{
"name": "Configuration - Policy TranslationProfile List Builder"
},
{
"name": "Configuration - Policy TranslationRules List Builder"
},
{
"name": "Configuration - Policy Trunk Group List Builder"
},
{
"name": "Configuration - Policy URL BlackList Builder"
},
{
"name": "Configuration - Policy URL Filtering Definition Builder"
},
{
"name": "Configuration - Policy URL WhiteList Builder"
},
{
"name": "Configuration - Policy Umbrella Data List Builder"
},
{
"name": "Configuration - Policy VPN List Builder"
},
{
"name": "Configuration - Policy VPN Membership Group Definition Builder"
},
{
"name": "Configuration - Policy VPN-Qos Map Definition Builder"
},
{
"name": "Configuration - Policy Voice Assembler"
},
{
"name": "Configuration - Policy Zone Based Firewall Definition Builder"
},
{
"name": "Configuration - Policy Zone List Builder"
},
{
"name": "Configuration - Policy vEdge Assembler"
},
{
"name": "Configuration - Policy vEdge Route Definition Builder"
},
{
"name": "Configuration - Policy vSmart Assembler"
},
{
"name": "Configuration - Preferred Color Group List Builder"
},
{
"name": "Configuration - Quick Connect"
},
{
"name": "Configuration - Rule Set Definition"
},
{
"name": "Configuration - SSL Decryption Policy Definition Builder"
},
{
"name": "Configuration - SSL Decryption UTD Profile Definition"
},
{
"name": "Configuration - Secure Internet Gateway Tunnels"
},
{
"name": "Configuration - Security Group Definition"
},
{
"name": "Configuration - Security Template Policy"
},
{
"name": "Configuration - Template Configuration"
},
{
"name": "Configuration - Template Lock"
},
{
"name": "Configuration - Template Master"
},
{
"name": "Configuration - Topology"
},
{
"name": "Configuration - Voice Template Policy"
},
{
"name": "Configuration - vEdge Template Policy"
},
{
"name": "Configuration - vSmart Template Policy"
}
],
"paths": {
"/template/cloudx": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get CloudX feature list",
"operationId": "getCloudXStatus",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX status": {
"description": "CloudX status",
"value": {
"data": [
{
"appType": "amazon_aws",
"longName": "Amazon AWS",
"totalSites": 2,
"goodSites": 0,
"badSites": 0,
"averageSites": 0
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-read,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/addcloudx/{type}": {
"post": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Add cloudx gateway",
"operationId": "addCloudxType",
"parameters": [
{
"name": "type",
"in": "path",
"description": "Cloudx type",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Cloudx",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloudx": {
"description": "Cloudx"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"deprecated": true,
"x-roles-required": "Template Configuration-write,Template Deploy-write,Cloud OnRamp-write"
}
},
"/template/cloudx/attachedclient": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get attached client site list",
"operationId": "getAttachedClientList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX attached client site": {
"description": "CloudX attached client site",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/attacheddia": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get attached Dia site list",
"operationId": "getAttachedDiaList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX attached Dia site": {
"description": "CloudX attached Dia site",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/attachedgateway": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get attached gateway list",
"operationId": "getAttachedGatewayList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX attached gateway": {
"description": "CloudX attached gateway",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/availableapps": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get CloudX available apps list",
"operationId": "getCloudXAvailableApps",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX app list": {
"description": "CloudX app list",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-read,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/clientlist": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get site list",
"operationId": "getSiteList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX site": {
"description": "CloudX site",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/dialist": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get Dia site list",
"operationId": "getDiaList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX Dia site": {
"description": "CloudX Dia site",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/gatewaylist": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get gateway list",
"operationId": "getGatewayList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX gateway": {
"description": "CloudX gateway",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/interfaces": {
"post": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Enable cloudx gateway",
"operationId": "addCloudxInterfaces",
"requestBody": {
"description": "Cloudx",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloudx": {
"description": "Cloudx"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-write,Template Deploy-write,Cloud OnRamp-write"
}
},
"/template/cloudx/manage/apps": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get apps and vpns",
"operationId": "getApps",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX apps and vpns": {
"description": "CloudX apps and vpns",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
},
"put": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Edit apps and vpns",
"operationId": "editApps",
"requestBody": {
"description": "Cloudx apps and vpns",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloudx apps and vpns": {
"description": "Cloudx apps and vpns",
"value": {
"appList": [
{
"appType": "amazon_aws",
"longName": "Amazon AWS",
"appVpnList": "1,10"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Change required": {
"description": "Change required",
"value": {}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-write,Template Deploy-write,Cloud OnRamp-write"
},
"post": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Add apps and vpns",
"operationId": "addApps",
"requestBody": {
"description": "Cloudx apps and vpns",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Cloudx apps and vpns": {
"description": "Cloudx apps and vpns",
"value": {
"appList": [
{
"appType": "amazon_aws",
"longName": "Amazon AWS",
"appVpnList": "1,5"
}
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX apps and vpns": {
"description": "CloudX apps and vpns",
"value": {
"pushRequired": false
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-write,Template Deploy-write,Cloud OnRamp-write"
}
},
"/template/cloudx/sig_tunnels": {
"get": {
"tags": [
"Configuration - Secure Internet Gateway Tunnels"
],
"description": "Get Secure Internet Gateway Tunnel List",
"operationId": "getSigTunnelList_ConfigurationSecureInternetGatewayTunnels_2803",
"parameters": [
{
"name": "deviceId",
"in": "query",
"description": "DeviceIp/SystemIp",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/cloudx/status": {
"get": {
"tags": [
"Configuration - CloudExpress"
],
"description": "Get sites per application per vpn",
"operationId": "sitePerApp",
"parameters": [
{
"name": "appName",
"in": "query",
"description": "App name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "vpnId",
"in": "query",
"description": "VPN Id",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"examples": {
"CloudX site": {
"description": "CloudX site",
"value": []
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-read,Cloud OnRamp-read,Cloud OnRamp-write"
}
},
"/template/config/attach/{deviceId}": {
"put": {
"tags": [
"Configuration - Template Configuration"
],
"description": "Upload device config",
"operationId": "uploadConfig",
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Device Model ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Template config",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Template config": {
"description": "Template config"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Device Inventory-write,Template Deploy-write"
}
},
"/template/config/attached/{deviceId}": {
"get": {
"tags": [
"Configuration - Template Configuration"
],
"description": "Get local template attached config for given device",
"operationId": "getAttachedConfig",
"parameters": [
{
"name": "deviceId",
"in": "path",
"description": "Device Model ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Config type",
"schema": {
"type": "string",
"enum": [
"CFS",
"RFS",
"DRAFT_RFS",
"DRAFT_CFS"
],
"default": "CFS"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"examples": {
"Attached config": {
"description": "Attached config",
"value": {
"config": "no config \nconfig\n system\n host-name vm1\n system-ip 172.16.255.11\n site-id 100\n port-offset 1\n admin-tech-on-failure\n admin-tech-on-software-rollback\n route-consistency-check\n no vrrp-advt-with-phymac\n organization-name \"vIPtela Inc Regression\"\n vbond vbond\n aaa\n auth-order local radius tacacs\n usergroup basic\n task system read\n task interface read\n !\n usergroup netadmin\n !\n usergroup operator\n task system read\n task interface read\n task policy read\n task routing read\n task security read\n !\n usergroup tenantadmin\n !\n user admin\n password $6$tebXK3g64oMdWjSp$kIbJ/qShDI4/eLQ0M8NLyCK7rlmsZAlnwGFqCVZc7rNlIE6f8O1Q6IuP4pHJinc8pSTNGAEYtoCAwDuAiGPF9/\n !\n ciscotacro-user true\n ciscotacrw-user true\n !\n logging\n disk\n enable\n !\n !\n ntp\n parent\n no enable\n stratum 5\n exit\n !\n support\n zbfw-tcp-finwait-time 30\n zbfw-tcp-idle-time 3600\n zbfw-tcp-synwait-time 30\n zbfw-udp-idle-time 30\n !\n !\n omp\n no shutdown\n graceful-restart\n timers\n holdtime 15\n graceful-restart-timer 120\n exit\n advertise ospf external\n advertise connected\n advertise static\n !\n security\n ipsec\n integrity-type ip-udp-esp esp\n !\n !\n vpn 0\n host vbond ip 10.0.12.26 2001:a0:c::1a\n interface ge0/1\n ip address 10.0.26.11/24\n no ipv6 shutdown\n no shutdown\n !\n interface ge0/2\n ip address 10.0.5.11/24\n no ipv6 shutdown\n tunnel-interface\n encapsulation ipsec\n color lte\n hello-tolerance 12\n no allow-service bgp\n allow-service dhcp\n allow-service dns\n allow-service icmp\n no allow-service sshd\n no allow-service netconf\n no allow-service ntp\n no allow-service ospf\n no allow-service stun\n allow-service https\n !\n no shutdown\n !\n in
# --- truncated at 32 KB (4586 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-catalyst-sdwan/refs/heads/main/openapi/cisco-catalyst-sdwan-ux-1-0-configuration-openapi.json