{"type":"api","title":"Get Compliance Details","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/744a8207-9965-344e-aed3-d3ef846a4950","info":{"title":"Others","description":"Other APIs\n- Include APIs that do not belong to other categories\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Compliance - Device Details"],"description":"Get compliance information for devices","operationId":"getComplianceDetails","parameters":[{"name":"offset","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":25}},{"name":"deviceType","in":"query","description":"deviceType example: vedge","schema":{"type":"array","items":{"type":"string","example":["vedge"]}}},{"name":"status","in":"query","schema":{"type":"array","example":["RED"],"items":{"type":"string","example":["RED"]}}},{"name":"type","in":"query","schema":{"type":"array","example":["vedge"],"items":{"type":"string","example":["vedge"]}}},{"name":"sort_by","in":"query","schema":{"type":"string"},"example":"host-name"},{"name":"order_by","in":"query","schema":{"type":"string","enum":["asc","desc"]},"example":"asc"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":9},"devices":{"type":"array","items":{"type":"object","properties":{"checkList":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","example":"Device is LTS - 1"},"status":{"type":"string","example":"GREEN"},"type":{"type":"string","example":"SOFTWARE_COMPLIANCE_CHECK"}},"$$ref":"#/components/schemas/DeviceCheckList"}},"deviceDetails":{"type":"object","properties":{"chassis-Number":{"type":"string","example":"390b3f83-ffc2-4081-9881-4c41bc8665e8"},"current-version":{"type":"string","example":"20.12.1"},"device-type":{"type":"string","example":"vedge"},"host-name":{"type":"string","example":"vm1"},"local-system-ip":{"type":"string","example":"172.168.0.1"},"personality":{"type":"string","example":"vedge"},"reachability":{"type":"string","example":"reachable"},"site-id":{"type":"string","example":"500"},"site-name":{"type":"string","example":"SITE_500"},"system-ip":{"type":"string","example":"172.168.0.1"},"uuid":{"type":"string","example":"390b3f83-ffc2-4081-9881-4c41bc8665e8"}},"$$ref":"#/components/schemas/DeviceApiDetails"},"status":{"type":"string","example":"GREEN"}},"$$ref":"#/components/schemas/DeviceComplianceApiData"}}},"$$ref":"#/components/schemas/DeviceComplianceApiResponse"},"examples":{"Example":{"description":"Example","value":{"count":9,"devices":[{"deviceDetails":{"local-system-ip":"172.168.0.1","system-ip":"172.168.0.1","site-id":"500","site-name":"SITE_500","host-name":"vm1","uuid":"390b3f83-ffc2-4081-9881-4c41bc8665e8","chassis-Number":"390b3f83-ffc2-4081-9881-4c41bc8665e8","reachability":"reachable","device-type":"vedge","personality":"vedge","current-version":"20.12.1"},"checkList":[{"type":"SOFTWARE_COMPLIANCE_CHECK","status":"GREEN","message":"Device is LTS - 1"}],"status":"GREEN"}]},"$$ref":"#/components/examples/ComViptelaVmanageServerDeviceCommonDeviceapiResponseExampleGetcompliance"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"get","path":"/device/compliance"}}