Add basic health check endpoint #1

New Issue

2025-09-23T14:15:09Z

boris commented

2025-09-23 14:15:09 +00:00

As an administrator, I want to ensure the API is running, and can monitor the endpoint for uptime

Acceptance Criteria (G/W/T)

Given the API is running, when I GET /healthz, then I receive 200 OK with body {"ok": true}.
Given any auth config, when I hit /healthz, then no authentication is required.
Given the API is unhealthy (future), when health depends on DB readiness (optional later), then the endpoint can reflect degraded state.

Notes / Non-functional

Response in < 50ms locally.
Documented in /docs.

As an administrator, I want to ensure the API is running, and can monitor the endpoint for uptime Acceptance Criteria (G/W/T) - [x] Given the API is running, when I GET /healthz, then I receive 200 OK with body {"ok": true}. - [x] Given any auth config, when I hit /healthz, then no authentication is required. - [x] Given the API is unhealthy (future), when health depends on DB readiness (optional later), then the endpoint can reflect degraded state. Notes / Non-functional - [x] Response in < 50ms locally. - [x] Documented in /docs.

boris added this to the Minimum Viable Product milestone 2025-09-23 14:15:09 +00:00

boris added the Kind/Feature

Priority

Critical

1

labels 2025-09-23 14:15:09 +00:00

boris self-assigned this 2025-09-23 14:15:09 +00:00

boris added this to the Keywarden project 2025-09-23 14:15:09 +00:00

boris moved this to Done in Keywarden on 2025-09-23 14:15:11 +00:00

boris moved this to Review in Keywarden on 2025-09-23 14:15:36 +00:00

boris moved this to Done in Keywarden on 2025-09-30 11:26:15 +00:00

boris commented