Skip to main content

Health API Reference

Monitor the health and status of the O1 backend service. The Health API provides essential information about service availability and performance.

Endpoints Overview

Health Check

Check Service Health

Response:

Response Details

Healthy Status

When all services are operating normally:

Degraded Status

When some services are experiencing issues:

Unhealthy Status

When critical services are down:

Service Status Codes

Monitoring Integration

External Health Checks

Integrate with external monitoring systems:

Automated Monitoring

Set up automated health checks:

Error Responses

Service Unavailable

When the health check endpoint itself is unavailable:

Best Practices

Health Check Configuration

  • Set appropriate timeout values for health checks
  • Implement circuit breaker patterns
  • Monitor health check response times
  • Set up alerting for unhealthy states

Service Monitoring

  • Monitor individual service health
  • Track service dependencies
  • Implement graceful degradation
  • Set up automated recovery procedures

Performance Monitoring

  • Monitor response times and throughput
  • Track resource utilization
  • Set performance baselines
  • Implement capacity planning

Integration Examples

Load Balancer Health Check

Container Health Check

Kubernetes Health Check

Troubleshooting

Common Issues

Service Not Starting
High Resource Usage
Connection Issues
For detailed schema definitions, refer to the OpenAPI specification published alongside the backend service.