Health

Liveness and dependency health, no auth

GET/healthz

Service health

Without parameters this only confirms the API process is serving requests. With deep=1 (or deep=true) it also pings Postgres, Redis and NATS and answers 503 when any of them is unreachable, so an external monitor can tell "process up" from "able to serve scrapes". Deep results are cached for 5 seconds.

Query

deep

boolean

Also check Postgres, Redis and NATS. Default: false.

Request

cURL

curl https://scraping-api.datafuel.ai/api/v1/healthz

Response

{
  "status": "ok"
}

{
  "status": "degraded",
  "checks": {
    "postgres": {
      "status": "ok",
      "latency_ms": 1
    },
    "redis": {
      "status": "fail",
      "latency_ms": 2000
    },
    "nats": {
      "status": "ok",
      "latency_ms": 0
    }
  }
}