Edit Config Group - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Edit Config Group","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/8bb2440c-2dd0-310b-8b55-fbbf55ba4b5c","info":{"title":"UX 2.0 Configuration","description":"Configuration of UX 2.0 device, policy, and topology\n\nIncludes API operations for the following\n- Configuration Groups (SD-WAN and SD-Routing)\n- Policy Groups\n- Topology Groups\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - Configuration Group"],"description":"Edit a Configuration Group","operationId":"EditConfigGroup","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Config Group","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_cgFpPpNameDef"},"description":{"type":"string"},"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/ConfiggroupCommonPutRequest_topologyDevicePropertiesDef"},"additionalProperties":false},"siteDevices":{"type":"integer","minimum":1,"maximum":20}},"required":["devices"],"additionalProperties":false,"$$ref":"#/components/schemas/ConfiggroupCommonPutRequest_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/ConfiggroupCommonPutRequest_profileIdObjDef"},"uniqueItems":true,"additionalProperties":false}},"required":["name","description","solution"],"additionalProperties":false,"$$ref":"#/components/schemas/ConfiggroupCommonPutRequest_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/ConfiggroupCommonPutRequest_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/ConfiggroupCommonPutRequest_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/ConfiggroupCommonPutRequest_CEDGE-ConfigGroup2-DualDeviceSiteDeployment"}}}},"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","enum":["global"]}},"required":["id","profileType"],"additionalProperties":false,"$$ref":"#/components/schemas/ConfiggroupCommonPutResponse_profileObjDef"}}},"required":["id"],"additionalProperties":false,"$$ref":"#/components/schemas/ConfiggroupCommonPutResponse_SchemaPayload"},"examples":{"example_1":{"value":{"id":"3EEF02A6-DD2A-bE42-ae6d-cda4CF2C30ac"},"$$ref":"#/components/examples/ConfiggroupCommonPutResponse_example_1"},"example_2":{"value":{"id":"5eDFc2F7-3F0A-0Efe-6E1f-E5caAE0C6060","profiles":[{"id":"002C4d1e-AA45-8e75-8CAB-C9CA0FE882a6","profileType":"global"}]},"$$ref":"#/components/examples/ConfiggroupCommonPutResponse_example_2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-write","method":"put","path":"/v1/config-group/{configGroupId}"}}