The UX 2.0 configuration surface: configuration groups, policy groups and topology groups, the group-based provisioning model that replaces device templates.
{
"openapi": "3.1.0",
"info": {
"title": "UX 2.0 Configuration",
"description": "Configuration of UX 2.0 device, policy, and topology\nIncludes API operations for the following\n Configuration Groups (SD-WAN and SD-Routing)\n Policy Groups\n Topology Groups",
"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 - Configuration Group"
},
{
"name": "Policy - Policy Group"
},
{
"name": "Topology - Topology Group"
}
],
"paths": {
"/v1/config-group": {
"get": {
"tags": [
"Configuration - Configuration Group"
],
"description": "Get a Configuration Group by Solution",
"operationId": "GetConfigGroupBySolution",
"parameters": [
{
"name": "solution",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"schema": {
"pattern": "^[^&<>! \"]{1,128}$",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"required": [
"name",
"solution",
"state",
"version"
],
"type": "object",
"properties": {
"copyInfo": {
"type": "string"
},
"createdBy": {
"type": "string",
"description": "User who last created this.",
"readOnly": true
},
"createdOn": {
"type": "integer",
"description": "Timestamp of creation",
"format": "int64",
"readOnly": true
},
"description": {
"type": "string",
"description": "Description of the Group.",
"example": "group for west coast retail stores"
},
"devices": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"fullConfigCli": {
"type": "boolean"
},
"id": {
"type": "string",
"description": "System generated unique identifier of the Group in UUID format.",
"example": "6fa14197-c25f-4a14-b81b-299de32ed2ca"
},
"iosConfigCli": {
"type": "boolean"
},
"lastUpdatedBy": {
"type": "string",
"description": "User who last updated this.",
"readOnly": true
},
"lastUpdatedOn": {
"type": "integer",
"description": "Timestamp of last update",
"format": "int64",
"readOnly": true
},
"name": {
"type": "string",
"description": "Name of the Group. Must be unique.",
"example": "West coast retail stores"
},
"numberOfDevices": {
"type": "integer",
"format": "int64"
},
"numberOfDevicesUpToDate": {
"type": "integer",
"format": "int64"
},
"origin": {
"type": "string"
},
"originInfo": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"profiles": {
"type": "array",
"description": "List of devices UUIDs associated with this group",
"example": [
{
"id": "6fa14197-c25f-4a14-b81b-299de32ed2ca",
"name": "system feature profile",
"solution": "sdwan",
"type": "system",
"description": "Profile file description",
"lastUpdatedBy": "admin",
"lastUpdatedOn": 1694179200000,
"createdBy": "admin",
"createdOn": 1694092800000,
"profileParcelCount": 5,
"origin": "internal"
}
],
"items": {
"required": [
"name",
"solution",
"type"
],
"type": "object",
"properties": {
"createdBy": {
"type": "string",
"description": "User who last created this.",
"readOnly": true
},
"createdOn": {
"type": "integer",
"description": "Timestamp of creation",
"format": "int64",
"readOnly": true
},
"description": {
"type": "string",
"description": "Description of the feature Profile.",
"example": "Profile file description"
},
"id": {
"type": "string",
"description": "System generated unique identifier of the feature profile in UUID format.",
"example": "6fa14197-c25f-4a14-b81b-299de32ed2ca"
},
"lastUpdatedBy": {
"type": "string",
"description": "User who last updated this.",
"readOnly": true
},
"lastUpdatedOn": {
"type": "integer",
"description": "Timestamp of last update",
"format": "int64",
"readOnly": true
},
"name": {
"type": "string",
"description": "Name of the feature Profile. Must be unique.",
"example": "system feature profile"
},
"origin": {
"type": "string"
},
"profileParcelCount": {
"type": "integer",
"description": "Number of Parcels attached with Feature Profile",
"format": "int64",
"readOnly": true
},
"solution": {
"type": "string",
"description": "Solution of the feature Profile.",
"example": "sdwan"
},
"type": {
"type": "string",
"description": "Type of the feature Profile.",
"example": "system"
}
},
"$$ref": "#/components/schemas/FeatureProfile"
}
},
"solution": {
"type": "string",
"description": "Specify one of the device platform solution",
"example": "sdwan",
"enum": [
"mobility",
"sdwan",
"sd-routing",
"common",
"nfvirtual",
"service-insertion",
"cellulargateway"
]
},
"source": {
"type": "string",
"description": "Source of group",
"example": "retail_workflow"
},
"state": {
"type": "string",
"description": " Group Deployment state",
"example": " Group Deployment state.Initial state Deployed "
},
"topology": {
"type": "object",
"properties": {
"devices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"criteria": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"enum": [
"tag"
]
},
"value": {
"type": "string"
}
},
"$$ref": "#/components/schemas/Criteria"
},
"unsupportedFeatures": {
"type": "array",
"items": {
"type": "object",
"properties": {
"parcelId": {
"type": "string",
"format": "uuid"
},
"parcelType": {
"type": "string",
"enum": [
"wan/vpn/interface/gre",
"wan/vpn/interface/ethernet",
"wan/vpn/interface/cellular",
"wan/vpn/interface/ipsec",
"wan/vpn/interface/serial",
"wan/vpn/interface/dsl-pppoe",
"wan/vpn/interface/dsl-pppoa",
"wan/vpn/interface/dsl-ipoe",
"routing/ospf",
"lan/vpn/interface/ethernet",
"lan/vpn/interface/gre",
"lan/vpn/interface/svi",
"lan/vpn/interface/ipsec",
"lan/vpn",
"global-vrf",
"vrf/wan/interface/gre",
"vrf/wan/interface/ethernet",
"vrf/wan/interface/ipsec",
"vrf/lan/interface/gre",
"vrf/lan/interface/ethernet",
"vrf/lan/interface/ipsec",
"vrf",
"vrf/routing/bgp",
"global-vrf/routing/bgp",
"wan/multicloud-connection",
"lan/multicloud-connection",
"vrf/wan/multicloud-connection",
"vrf/lan/multicloud-connection",
"global-vrf/wan/interface/ipsec",
"routing/bgp",
"route-policy",
"service-insertion-attachment"
]
}
},
"$$ref": "#/components/schemas/UnsupportedFeature"
}
}
},
"$$ref": "#/components/schemas/ConfigGroupDevice"
}
},
"siteDevices": {
"type": "integer",
"format": "int32"
}
},
"$$ref": "#/components/schemas/Topology"
},
"version": {
"type": "integer",
"description": " Group Version Flag",
"format": "int64"
},
"versionIncrementReason": {
"type": "string"
}
},
"$$ref": "#/components/schemas/ConfigGroup"
}
},
"examples": {
"West coast retail stores": {
"value": [
{
"description": "group for west coast retail stores",
"id": "6fa14197-c25f-4a14-b81b-299de32ed2ca",
"name": "West coast retail stores",
"profiles": [
{
"description": "Profile file description",
"id": "6fa14197-c25f-4a14-b81b-299de32ed2ca",
"name": "system feature profile",
"solution": "sdwan",
"type": "system"
}
],
"solution": "sdwan",
"source": "retail_workflow",
"state": " Group Deployment state.Initial state Deployed "
}
]
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error"
}
},
"x-roles-required": "Config Group-read"
},
"post": {
"tags": [
"Configuration - Configuration Group"
],
"description": "Create a new Configuration Group",
"operationId": "CreateConfigGroup",
"requestBody": {
"description": "Config Group",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[^&<>! \"]+$",
"minLength": 1,
"maxLength": 128,
"$$ref": "#/components/schemas/CommonCommonDefs_cgFpPpNameDef"
},
"description": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"retail_workflow",
"custom_workflow",
"nfvirtual_workflow",
"equinix_workflow"
]
},
"solution": {
"type": "string",
"enum": [
"mobility",
"sdwan",
"sd-routing",
"nfvirtual",
"service-insertion",
"cellulargateway"
],
"$$ref": "#/components/schemas/CommonCommonDefs_solutionDef"
},
"topology": {
"type": "object",
"description": "list of device provisioning rules that belongs to the config group topology",
"properties": {
"devices": {
"type": "array",
"description": "list of devices in a site",
"minItems": 1,
"maxItems": 20,
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"criteria": {
"type": "object",
"oneOf": [
{
"properties": {
"attribute": {
"type": "string",
"enum": [
"tag"
]
},
"value": {
"type": "string",
"pattern": "^[a-zA-Z0-9_\\-]+$"
}
},
"required": [
"attribute",
"value"
],
"additionalProperties": false
}
]
},
"unsupportedFeatures": {
"type": "array",
"uniqueItems": true,
"items": {
"properties": {
"parcelType": {
"type": "string",
"enum": [
"wan/vpn/interface/gre",
"wan/vpn/interface/ethernet",
"wan/vpn/interface/cellular",
"wan/vpn/interface/ipsec",
"wan/vpn/interface/serial",
"wan/vpn/interface/dsl-pppoa",
"wan/vpn/interface/dsl-pppoe",
"wan/vpn/interface/dsl-ipoe",
"routing/ospf",
"lan/vpn/interface/ethernet",
"lan/vpn/interface/svi",
"lan/vpn/interface/ipsec",
"lan/vpn",
"wan/multicloud-connection",
"lan/multicloud-connection",
"vrf/wan/interface/gre",
"vrf/wan/interface/ethernet",
"vrf/wan/interface/ipsec",
"vrf/lan/interface/ethernet",
"vrf/lan/interface/ipsec",
"vrf",
"vrf/wan/multicloud-connection",
"vrf/lan/multicloud-connection",
"vrf/routing/bgp",
"routing/bgp",
"route-policy"
],
"$$ref": "#/components/schemas/CommonCommonDefs_unsupportedFeaturesEnumDef"
},
"parcelId": {
"type": "string",
"format": "uuid"
}
},
"required": [
"parcelType",
"parcelId"
],
"additionalProperties": false
},
"additionalProperties": false
}
},
"required": [
"criteria"
],
"additionalProperties": false,
"$$ref": "#/components/schemas/ConfiggroupCommonPostRequest_topologyDevicePropertiesDef"
},
"additionalProperties": false
},
"siteDevices": {
"type": "integer",
"minimum": 1,
"maximum": 20
}
},
"required": [
"devices"
],
"additionalProperties": false,
"$$ref": "#/components/schemas/ConfiggroupCommonPostRequest_topologyDef"
},
"profiles": {
"type": "array",
"description": "list of profile ids that belongs to the config group",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
},
"required": [
"id"
],
"additionalProperties": false,
"$$ref": "#/components/schemas/ConfiggroupCommonPostRequest_profileIdObjDef"
},
"uniqueItems": true,
"additionalProperties": false
},
"fromConfigGroup": {
"type": "object",
"description": "from another config group",
"oneOf": [
{
"properties": {
"copy": {
"type": "string",
"pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}",
"$$ref": "#/components/schemas/CommonCommonDefs_uuidDef"
}
},
"required": [
"copy"
],
"additionalProperties": false
}
],
"$$ref": "#/components/schemas/ConfiggroupCommonPostRequest_fromConfigGroupDef"
}
},
"required": [
"name",
"description",
"solution"
],
"additionalProperties": false,
"$$ref": "#/components/schemas/ConfiggroupCommonPostRequest_SchemaPayload"
},
"examples": {
"CEDGE-ConfigGroup1-NY": {
"value": {
"name": "CEDGE-ConfigGroup1-NY",
"description": "CEDGE Config Group 1 for devices at site NY",
"solution": "sdwan",
"profiles": [
{
"id": "EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FED"
},
{
"id": "4D7eb1e4-Bf34-9aeA-58d8-C86824ECF8f4"
},
{
"id": "4C56e3c3-C67F-Cf66-d02f-8c666bd005CC"
}
]
},
"$$ref": "#/components/examples/ConfiggroupCommonPostRequest_CEDGE-ConfigGroup1-NY"
},
"AON-ConfigGroup1-SF": {
"value": {
"name": "AON-ConfigGroup1-SF",
"description": "AON Config Group 1 for devices at site SF",
"solution": "mobility"
},
"$$ref": "#/components/examples/ConfiggroupCommonPostRequest_AON-ConfigGroup1-SF"
},
"CEDGE-ConfigGroup2-DualDeviceSiteDeployment": {
"value": {
"name": "CEDGE-ConfigGroup2-DualDeviceSiteDeployment",
"description": "CEDGE Config Group 2 for Dual Device Site Deployment",
"solution": "sdwan",
"topology": {
"devices": [
{
"criteria": {
"attribute": "tag",
"value": "EdgeDevice_01"
},
"unsupportedFeatures": [
{
"parcelType": "wan/vpn/interface/ethernet",
"parcelId": "EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEE"
},
{
"parcelType": "wan/vpn/interface/ethernet",
"parcelId": "EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEF"
},
{
"parcelType": "wan/vpn/interface/ethernet",
"parcelId": "EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEG"
}
]
},
{
"criteria": {
"attribute": "tag",
"value": "EdgeDevice_02"
},
"unsupportedFeatures": [
{
"parcelType": "wan/vpn/interface/ethernet",
"parcelId": "FFBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEE"
},
{
"parcelType": "wan/vpn/interface/ethernet",
"parcelId": "FGBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEF"
},
{
"parcelType": "wan/vpn/interface/ethernet",
"parcelId": "FMBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEG"
}
]
}
],
"siteDevices": 2
},
"profiles": [
{
"id": "EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FED"
},
{
"id": "4D7eb1e4-Bf34-9aeA-58d8-C86824ECF8f4"
},
{
"id": "4C56e3c3-C67F-Cf66-d02f-8c666bd005CC"
}
]
},
"$$ref": "#/components/examples/ConfiggroupCommonPostRequest_CEDGE-ConfigGroup2-DualDeviceSiteDeployment"
},
"NFVIRTUAL-ConfigGroup1-SF": {
"value": {
"name": "NFVIRTUAL-ConfigGroup1-SF",
"description": "NFVIRTUAL Config Group 1 for devices at site SF",
"solution": "nfvirtual",
"profiles": [
{
"id": "EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99"
},
{
"id": "4D7eb1e4-Bf34-9aeA-58d8-C86824ECF8f4"
}
]
},
"$$ref": "#/components/examples/ConfiggroupCommonPostRequest_NFVIRTUAL-ConfigGroup1-SF"
},
"CEDGE-ConfigGroup1-COPY": {
"value": {
"name": "CEDGE-ConfigGroup1-COPY",
"description": "Copy Config Group from EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99",
"solution": "sdwan",
"fromConfigGroup": {
"copy": "EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99"
}
},
"$$ref": "#/components/examples/ConfiggroupCommonPostRequest_CEDGE-ConfigGroup1-COPY"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"
},
"profiles": {
"type": "array",
"description": "(Optional - only applicable for AON) List of profile ids that belongs to the config group",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"profileType": {
"type": "string",
# --- truncated at 32 KB (215 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-catalyst-sdwan/refs/heads/main/openapi/cisco-catalyst-sdwan-ux-2-0-configuration-openapi.json