OVOK DOCS
Get startedOvokSignalsSDKsGuidesAPI referenceDeveloper resources
Healthcheck

Get application readiness

  • Sandbox: available
  • Staging: available
  • Production: unknown
GET
/healthcheck/ready

Returns the same body as the liveness healthcheck, but with the verdict in the HTTP status. Use it for monitors and alerts that page on status code.

Auth: none. The route needs no bearer token.

Behaviour

  • Runs the same bounded Redis and FHIR store probes as GET /healthcheck.
  • Answers 200 when ok is true and 503 when it is false. The 503 body is the same healthcheck result, so dependencies still names the failing dependency.
  • Do not use this route for container liveness probes: a failing dependency would make the orchestrator restart a backend that is merely degraded.

Example

curl -X GET 'https://api.sandbox.ovok.com/healthcheck/ready'

Response Body

Healthcheck result, HTTP 200 when healthy and 503 when a dependency is down.

application/json
  1. response
ok*boolean

True only when Redis and the FHIR store in dependencies answered inside the probe timeout. The HTTP status stays 200 either way — read this field, not the status code.

dependencies*

Per-dependency probe verdicts. Always present, so a monitor can name the failing dependency.

version?
buildEnv?
commitHash?
buildDate?
runningSince?
Example Request
curl -X GET 'https://api.sandbox.ovok.com/healthcheck/ready'
Example Response
{  "ok": true,  "dependencies": {},  "version": {},  "buildEnv": {},  "commitHash": {},  "buildDate": {},  "runningSince": {}}

Get application readiness GET

Returns the same body as the liveness healthcheck, but with the verdict in the HTTP status. Use it for monitors and alerts that page on status code. **Auth:** none. The route needs no bearer token. ## Behaviour - Runs the same bounded Redis and FHIR store probes as `GET /healthcheck`. - Answers `200` when `ok` is `true` and `503` when it is `false`. The `503` body is the same healthcheck result, so `dependencies` still names the failing dependency. - Do not use this route for container liveness probes: a failing dependency would make the orchestrator restart a backend that is merely degraded. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/healthcheck/ready' ```

Check Redis health GET

Checks whether the backend can reach Redis. **Auth:** none. The route needs no bearer token. ## Behaviour - Sends a `PING` to Redis. `ok` is `true` only when Redis answers `PONG`, and `false` on any error. - The status is `200` in both cases. - Unlike `GET /healthcheck`, this probe has no time limit of its own. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/healthcheck/redis' ``` ```json { "ok": true } ```