GET /healthz

Liveness-Check (Caddy + docker-compose)

stable seit v0.1.0 ops auth: none

GET /healthz — Liveness-Check

Antwortet 200 OK mit {"status": "ok", "service": "lodapi-api"} solange der API-Container läuft. Wird vom Caddy-Reverse-Proxy + Docker-Compose-Healthcheck konsumiert.

Wann verwenden

  • Monitoring-Pings (Prometheus-Blackbox, Uptime-Robot, …).
  • Caddy / Load-Balancer Health-Probes.
  • Sanity-Test nach jedem Deploy.

Example

curl -s https://api.lodapi.de/healthz | jq
# {"status": "ok", "service": "lodapi-api"}

Parameters

Keine.

Response

200 OK · application/json:

{
  "status": "ok",
  "service": "lodapi-api"
}

Stolperdrähte

  • Kein DB-Check in dieser Antwort. Postgres kann down sein und /healthz antwortet trotzdem 200. Für DB-Liveness eigene Probe gegen /v1/datasets schicken.
  • Phase 2 wird einen tieferen /readyz ergänzen, der DB-Connection-Pool + Auth-Provider prüft.

Verwandte Endpoints

Keine — Health ist orthogonal zum Datenmodell.

Bereit?

Der erste Call geht sofort.

LoD2-Gebäude für alle 16 Bundesländer, kostenlos und ohne Konto. Pro auf Anfrage 30 Tage testen.