pinakes/docs/api/health.md
NotAShelf 934691c0f9
docs: auto-generate API route documentation
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Id0d1f9769b7ccdbf83d5fa78adef62e46a6a6964
2026-03-22 22:04:52 +03:00

1 KiB

Health

Server health checks

Endpoints

GET /api/v1/health

Comprehensive health check - includes database, filesystem, and cache status

Authentication: Required (Bearer JWT)

Responses

Status Description
200 Health status

GET /api/v1/health/detailed

Authentication: Required (Bearer JWT)

Responses

Status Description
200 Detailed health status

GET /api/v1/health/live

Liveness probe - just checks if the server is running Returns 200 OK if the server process is alive

Authentication: Required (Bearer JWT)

Responses

Status Description
200 Server is alive

GET /api/v1/health/ready

Readiness probe - checks if the server can serve requests Returns 200 OK if database is accessible

Authentication: Required (Bearer JWT)

Responses

Status Description
200 Server is ready
503 Server not ready