Health API
Health check and monitoring endpoints
Quick Reference
| Method | Endpoint | Auth | Description |
|---|---|---|---|
GET | /api/health/details.ts | 🔓 | Detailed health check endpoint Returns detailed he... |
GET | /api/health/proxy.ts | 🔓 | No description available |
GET | /api/health/ready.ts | 🔓 | Readiness probe endpoint Returns OK if all critica... |
GET | /api/health/live.ts | 🔓 | Liveness probe endpoint Returns OK if the process ... |
GET | /api/health/history.ts | 🔓 | Health check history endpoint Returns historical h... |
GET | /api/admin/health/details | 🔓 | GET /api/admin/health/details Returns detailed hea... |
POST | /api/admin/health/fetch-test | 🔓 | POST /api/admin/health/fetch-test Dev/debug tool: ... |
Endpoints
GET /api/health/details.ts
Detailed health check endpoint Returns detailed health information for all system components
Response
type Response = DetailedHealthResponse📁 Source: server/api/health/details.ts
GET /api/health/proxy.ts
No description available
Response
type Response = HealthCheckResult📁 Source: server/api/health/proxy.ts
GET /api/health/ready.ts
Readiness probe endpoint Returns OK if all critical dependencies are healthy Used by container orchestrators and load balancers to determine if the container can receive traffic
Response
type Response = ReadinessResponse📁 Source: server/api/health/ready.ts
GET /api/health/live.ts
Liveness probe endpoint Returns OK if the process is running Used by container orchestrators to determine if the container should be restarted
Response
type Response = LivenessResponse📁 Source: server/api/health/live.ts
GET /api/health/history.ts
Health check history endpoint Returns historical health check data for visualization
Response
type Response = HistoricalHealthData[]📁 Source: server/api/health/history.ts
GET /api/admin/health/details
GET /api/admin/health/details Returns detailed health check information for the admin panel. Includes all probe results with full metadata, server process info, and sampler status.
Response
type Response = SuccessResponse<T>📁 Source: server/api/admin/health/details.get.ts
POST /api/admin/health/fetch-test
POST /api/admin/health/fetch-test Dev/debug tool: executes an HTTP request from the server process so admins can test connectivity to external services (e.g. steam-service) using the same network context as the running app.
Response
type Response = SuccessResponse<T>📁 Source: server/api/admin/health/fetch-test.post.ts