GET /v1/agents/{agent_id}/health
Check the health status of a deployed agent.Request
Path Parameters
string
required
The unique identifier of the agent
Response
string
required
Overall health status:
healthy, degraded, or unhealthyobject
required
Individual health check results
string
Current agent version
number
Uptime in seconds
Examples
Basic Health Check
Response Examples
Healthy Agent
Degraded Agent
Health Check Logic
Status is determined by:- Healthy: All checks pass
- Degraded: Some checks show warnings but agent is functional
- Unhealthy: Critical checks fail
Monitoring Integration
Automated Monitoring
Prometheus Integration
Best Practices
- Regular Monitoring: Check health every 30-60 seconds
- Set Alerts: Alert on status changes
- Track Trends: Monitor resource usage over time
- Implement Retries: Handle temporary network issues
See Also
- Monitoring Guide - Full monitoring setup
- Status Endpoint - Detailed agent info
- Metrics API - Metrics collection