API reference · System
GET/api/readyz

Readiness probe

Kubernetes readiness endpoint for the Next.js API route. It checks database connectivity with SELECT 1 and returns 200 only when critical dependencies are available. The Redis check is currently a placeholder that mirrors the database result. This endpoint is unauthenticated and is explicitly skipped by API-key middleware.

Response body

Success response 200 · schema ReadyzReadyResponse

statusstringRequired
All critical dependencies checked by this handler are available.
Enum: ready
timestampstring <date-time>Required
ISO timestamp generated when the readiness check is handled.
uptimenumberRequired
Process uptime in seconds from process.uptime().
≥ 0
versionstringRequired
Application version from npm_package_version, with handler fallback.
checksobjectRequired
databasebooleanRequired
True when a SELECT 1 database connectivity check succeeds.
redisbooleanRequired
Redis readiness placeholder. Currently mirrors the database check result.

Response codes

200
All critical dependencies checked by this handler are available.
503
One or more critical dependencies are unavailable, or a readiness check threw an exception.