Health Check

Monitor server performance, system resources, and service availability

GET
/api/v1/health
Server Health Monitoring
Monitor server performance, system resources, and service availability in real-time.
Purpose: This endpoint provides comprehensive health metrics including system performance, memory usage, and feature availability status.
Health Metrics
Metric Type Description
status string Overall server health status
uptime number Server uptime in seconds
memory object Memory usage statistics
performance object Request count and response times
Request
curl -X GET http://localhost:3001/api/v1/health
Response Example
{
  "status": "healthy",
  "timestamp": "2025-12-22T03:39:20.602Z",
  "uptime": 3600.5,
  "version": "1.0.0",
  "environment": "development",
  "system": {
    "memory": {
      "used": 45.2,
      "total": 16384,
      "percentage": 0.28
    },
    "cpu": {
      "usage": 12.5
    },
    "performance": {
      "requestCount": 150,
      "errorRate": 0.02,
      "averageResponseTime": 245
    }
  },
  "features": {
    "quizIntelligence": true,
    "batchProcessing": true,
    "caching": true
  }
}
Health Status Codes
Status HTTP Code Description
healthy 200 All systems operational
degraded 200 Some features may be impacted
unhealthy 503 Service unavailable or critical issues