Get Config Group By Solution - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get Config Group By Solution","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":"Get a Configuration Group by Solution","operationId":"GetConfigGroupBySolution","parameters":[{"name":"solution","in":"query","schema":{"type":"string"}},{"name":"name","in":"query","schema":{"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":"West coast retail store devices","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"}},"description":"List of devices UUIDs associated with this group","example":"West coast retail store devices","$$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","method":"get","path":"/v1/config-group"}}