API Reference
Health check
Public endpoint for monitoring API health status.
Endpoint: GET /api/v1/health
Availability: Live in production.
Authentication: None.
Public endpoint for monitoring API health status. Returns database and Redis connectivity checks. Used for load balancer health checks. No authentication required.
Example request
curl -X GET "https://backworkhealth.com/api/v1/health"Example response (200)
{
"success": true,
"data": {
"status": "healthy",
"version": "v1",
"checks": {},
"timestamp": "2026-01-15T10:30:00Z"
},
"meta": {
"request_id": "string",
"timestamp": "2026-01-15T10:30:00Z"
}
}Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/health"{ "success": true, "data": { "status": "healthy", "version": "v1", "checks": { "property1": { "status": "healthy", "latency_ms": 0 }, "property2": { "status": "healthy", "latency_ms": 0 } }, "timestamp": "2019-08-24T14:15:22Z" }, "meta": { "request_id": "string", "timestamp": "2019-08-24T14:15:22Z" }}Last updated on