{"type":"api","title":"Get Config Group Association","meta":{"id":"/apps/pubhub/media/sd-wan-api-20-16/58fb893fa751949ea20a40274e9ab219a20e19fa/e77267b5-7b4b-3f93-807c-c6d1c6b41343","info":{"title":"Cisco Catalyst SD-WAN Manager API","description":"The vManage API exposes the functionality of operations maintaining devices and the overlay network","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":"2.0.0"},"openapi":"3.0.1","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - Configuration Group"],"description":"Get devices association with a config group","operationId":"GetConfigGroupAssociation","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"title":"Config Group Associate GET response","description":"Schema for the response of a GET request to associate a config group","type":"object","properties":{"devices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the device","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}"},"site-name":{"type":"string","description":"Name of the site"},"host-name":{"type":"string","description":"Host name of the device"},"site-id":{"type":"string","description":"Identifier for the site"},"deviceModel":{"type":"string","description":"Model of the device"},"tags":{"type":"array","description":"Tags associated with the device","items":{"type":"string"}},"device-lock":{"type":"string","description":"Indicates if the device is locked"},"addedByRule":{"type":"boolean","description":"Indicates if the device was added by a rule"},"configStatusMessage":{"type":"string","description":"Configuration status message"},"deviceIP":{"type":"string","description":"IP address of the device","format":"ipv4"},"configGroupLastUpdatedOn":{"type":"string","description":"Timestamp of the last update to the config group","format":"date-time"},"unsupportedFeatures":{"type":"array","description":"List of unsupported features","items":{"type":"string"}},"hierarchyNamePath":{"type":"string","description":"Hierarchy name path"},"hierarchyTypePath":{"type":"string","description":"Hierarchy type path"},"configGroupUpToDate":{"type":"string","description":"Indicates if the config group is up to date"}},"required":["id","site-name","host-name","site-id","deviceModel","tags","device-lock","addedByRule","configStatusMessage","deviceIP","configGroupLastUpdatedOn","unsupportedFeatures","hierarchyNamePath","hierarchyTypePath","configGroupUpToDate"]}}},"required":["devices"],"additionalProperties":false,"$$ref":"#/components/schemas/response_schema"},"examples":{"Config Group Associate":{"description":"Config Group Associate","value":{"devices":[{"id":"C8K-0f43906e-bd8f-443c-83f2-11eb85e45a51","site-name":"SITE_500","host-name":"vm5","site-id":"500","deviceModel":"vedge-C8000V","tags":[],"device-lock":"No","addedByRule":false,"configStatusMessage":"","deviceIP":"172.16.255.15","configGroupLastUpdatedOn":"","unsupportedFeatures":[],"hierarchyNamePath":"Global/SITE_500","hierarchyTypePath":"GLOBAL/SITE","configGroupUpToDate":"False"}]},"$$ref":"#/components/examples/associate"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group \u003e Device-read","__originalOperationId":"GetConfigGroupAssociation","method":"get","path":"/v1/config-group/{configGroupId}/device/associate"}}