Health Endpoints
Monitor system health and readiness with these endpoint options.
GET
/health
Basic health check endpoint
Request
curl -X {endpoint.method} https://api.example.com{endpoint.path} \
-H "Authorization: Basic base64(username:password)"Response
{
"environment": "production",
"service": "Unified Communications Platform",
"status": "ok",
"timestamp": "2024-11-20T10: 30: 15.123Z",
"uptime": "30d 5h 14m 32s",
"version": "2.1.4"
}
GET
/health/detailed
Detailed health check with dependency status
Request
curl -X {endpoint.method} https://api.example.com{endpoint.path} \
-H "Authorization: Basic base64(username:password)"Response
{
"checks": {
"cache": {
"hit_ratio": 0.94,
"message": "Cache is working",
"status": "healthy"
},
"database": {
"message": "Database connection successful",
"response_time_ms": 12,
"status": "healthy"
},
"external_services": {
"client_server": {
"message": "Client server is accessible",
"response_time_ms": 89,
"status": "healthy"
},
"sms_server": {
"message": "SMS server is accessible",
"response_time_ms": 156,
"status": "healthy"
}
},
"log_database": {
"message": "Log database connection successful",
"response_time_ms": 8,
"status": "healthy"
},
"message_queue": {
"message": "Message queue is accessible",
"queue_size": 42,
"status": "healthy"
},
"notification_database": {
"message": "Notification database connection successful",
"response_time_ms": 15,
"status": "healthy"
}
},
"environment": "production",
"service": "Unified Communications Platform",
"status": "healthy",
"timestamp": "2024-11-20T10: 30: 15.123Z",
"uptime": {
"human_readable": "30d 0h 0m 0s",
"seconds": 2592000
},
"version": "2.1.4"
}
GET
/health/ready
Readiness probe for container orchestration
Request
curl -X {endpoint.method} https://api.example.com{endpoint.path} \
-H "Authorization: Basic base64(username:password)"Response
{
"dependencies_ready": true,
"service": "Unified Communications Platform",
"status": "ready",
"timestamp": "2024-11-20T10: 30: 15.123Z"
}
GET
/health/live
Liveness probe for container orchestration
Request
curl -X {endpoint.method} https://api.example.com{endpoint.path} \
-H "Authorization: Basic base64(username:password)"Response
{
"cpu_usage_percent": 12.3,
"memory_usage_mb": 234.5,
"pid": "12345",
"service": "Unified Communications Platform",
"status": "alive",
"timestamp": "2024-11-20T10: 30: 15.123Z"
}