{"type":"api","title":"Device health overview data","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/d2f02ba2-fd0d-3a26-bcc5-feafc8f24d17","info":{"title":"Monitoring and Troubleshooting","description":"Includes API operations for the following:\n- Real-time monitoring\n- Accessing statistics APIs and statistics bulk APIs\n- Retrieving device state\n- Managing alarms and events\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Monitoring - Device Health"],"summary":"Device health overview data","description":"Get all device health overview ","operationId":"getDeviceHealthOverview","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32","default":12}},{"name":"site","in":"query","schema":{"type":"string"}},{"name":"personality","in":"query","schema":{"type":"string","enum":["vsmart","vbond","vmanage","vedge"],"default":"vedge"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":30}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"fair":{"type":"array","items":{"required":["cpu_load","health","health_score","host_name","memory_utilization","qoe","reachability","site_id","system_ip"],"type":"object","properties":{"cpu_load":{"type":"number","format":"double","example":1.32},"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double","example":10},"host_name":{"type":"string","example":"vm11"},"memory_utilization":{"type":"number","format":"double","example":43.03},"qoe":{"type":"number","format":"double","example":10},"reachability":{"type":"string","example":"reachable"},"site_id":{"type":"string","example":"600"},"system_ip":{"type":"string","example":"172.16.255.21"}},"$$ref":"#/components/schemas/DeviceHealthDetailItem"}},"good":{"type":"array","items":{"required":["cpu_load","health","health_score","host_name","memory_utilization","qoe","reachability","site_id","system_ip"],"type":"object","properties":{"cpu_load":{"type":"number","format":"double","example":1.32},"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double","example":10},"host_name":{"type":"string","example":"vm11"},"memory_utilization":{"type":"number","format":"double","example":43.03},"qoe":{"type":"number","format":"double","example":10},"reachability":{"type":"string","example":"reachable"},"site_id":{"type":"string","example":"600"},"system_ip":{"type":"string","example":"172.16.255.21"}},"$$ref":"#/components/schemas/DeviceHealthDetailItem"}},"poor":{"type":"array","items":{"required":["cpu_load","health","health_score","host_name","memory_utilization","qoe","reachability","site_id","system_ip"],"type":"object","properties":{"cpu_load":{"type":"number","format":"double","example":1.32},"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double","example":10},"host_name":{"type":"string","example":"vm11"},"memory_utilization":{"type":"number","format":"double","example":43.03},"qoe":{"type":"number","format":"double","example":10},"reachability":{"type":"string","example":"reachable"},"site_id":{"type":"string","example":"600"},"system_ip":{"type":"string","example":"172.16.255.21"}},"$$ref":"#/components/schemas/DeviceHealthDetailItem"}}},"$$ref":"#/components/schemas/DeviceHealthOverviewDetail"},"total":{"type":"object","properties":{"fair":{"type":"number","example":100},"good":{"type":"number","example":100},"poor":{"type":"number","example":100}},"$$ref":"#/components/schemas/DeviceHealthOverviewTotal"}},"$$ref":"#/components/schemas/DeviceHealthOverview"}}}},"400":{"description":"bad input parameter"}},"method":"get","path":"/statistics/devicehealth/overview/{type}"}}