{"type":"api","title":"Get Devices Health","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 - Health"],"description":"get the devices health properties","operationId":"getDevicesHealth","parameters":[{"name":"page","in":"query","description":"Page Number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"Page Size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"Sort By Property","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"Sort Order","schema":{"type":"string"}},{"name":"startingDeviceId","in":"query","description":"Optional device ID to start first page","schema":{"type":"string"}},{"name":"siteId","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}},{"name":"group_id","in":"query","description":"Optional group ID to filter devices","schema":{"type":"string"}},{"name":"groupId","in":"query","description":"Optional group ID to filter devices","schema":{"type":"string"}},{"name":"vpnId","in":"query","description":"Optional vpn ID to filter devices","schema":{"type":"string"}},{"name":"reachable","in":"query","schema":{"type":"boolean"}},{"name":"controlStatus","in":"query","schema":{"type":"string"}},{"name":"personality","in":"query","schema":{"type":"string"}},{"name":"health","in":"query","schema":{"type":"string"}},{"name":"site-id","in":"query","description":"Optional site ID list to filter devices","schema":{"type":"string"}},{"name":"featureType","in":"query","schema":{"type":"string","enum":["cellular","SCC"]}},{"name":"corSaasStatus","in":"query","schema":{"type":"boolean"}},{"name":"includeTenantvSmart","in":"query","description":"Include vSmarts in tenant view","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"devices health properties":{"description":"devices health properties","value":{"total_devices":3,"devices":[{"name":"vm3","personality":"vedge","uuid":"04a116f8-9a16-4bf6-9f1f-f58e2619312d","reachability":"reachable","longitude":"-122.777023","latitude":"37.666684","health":"green","qoe":10,"location":"lat: 37.666684, long: -122.777023","site_id":"3","system_ip":"169.254.10.10","device_type":"vedge","local_system_ip":"172.16.254.2","device_model":"vEdge Cloud","software_version":"20.6.0-231","cpu_load":1.32,"memory_utilization":25,"control_connections":3,"control_connections_up":3,"sdra_ipsec_anyconnect":120,"sdra_ipsec_soho":60,"sdra_ipsec_unknown":30,"sdra_sslvpn_anyconnect":0,"has_geo_data":true,"uptime_date":1629963840000,"device_groups":["No groups"],"connected_vmanages":["169.254.10.3"],"bfd_sessions_up":5,"bfd_sessions":5,"omp_peers":2,"omp_peers_up":2,"board_serial_number":"12345708","chassis_number":"04a116f8-9a16-4bf6-9f1f-f58e2619312d","vpn_ids":null}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write,System360 Diagnostic-read,System360 Diagnostic-write","method":"get","path":"/health/devices"}}