OVOK DOCS
Get startedOvokSignalsSDKsGuidesAPI referenceDeveloper resources
Healthcheck

Get application health

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

Returns the health of the Ovok backend and its Redis and FHIR store dependencies, together with build identity. Use it for liveness probes and as the source for a monitor that reads the response body.

Auth: none. The route needs no bearer token.

Behaviour

  • Also served at / and /_health.
  • Redis and FHIR store are probed in parallel. Each probe has a 2000 ms limit. A timeout or an error counts as ok: false for that dependency.
  • ok is true only when both dependencies.redis.ok and dependencies.fhirStore.ok are true. Email is not checked.
  • The HTTP status is always 200, even when a dependency is down. Read ok and dependencies from the body. To get a non-2xx status on failure, use GET /healthcheck/ready.
  • version, buildEnv, commitHash and buildDate identify the build and are null when the build did not set them. runningSince is the process start time.

Example

curl -X GET 'https://api.sandbox.ovok.com/healthcheck'
{  "ok": true,  "dependencies": { "redis": { "ok": true }, "fhirStore": { "ok": true } },  "buildEnv": "production",  "runningSince": "2026-04-12T17:21:21.410Z"}

Response Body

Healthcheck result. Always HTTP 200.

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'
Example Response
{  "ok": true,  "dependencies": {},  "version": {},  "buildEnv": {},  "commitHash": {},  "buildDate": {},  "runningSince": {}}

Change an email provider PATCH

Changes an email provider your current project has set up: replaces its secret, the sender address, or both. Each value is stored encrypted and is never returned. **Auth:** bearer token of a project admin. The caller must also be a Practitioner, an admin or hold the System Owner access policy. **Scope:** the caller's project (from the token). ## Behaviour - `provider` names the provider to change. One that is not set up returns 404 `PROVIDER_NOT_CONFIGURED`: set it up with `POST /v1/email/templates/provider`. - Send `secret`, `from`, or both. The rules are those of `POST`; a secret the provider does not take returns 422 `INVALID_SECRET`. - `from` is one sender address for the whole project, so changing it changes it for every provider. It cannot be cleared, only replaced. - When the server has no encryption key, nothing is stored and the answer is 503 `ENCRYPTION_UNAVAILABLE`. - A 409 means the project changed while the server wrote. Read it again and retry. - The answer has the project's providers as `GET /v1/email/templates/provider` returns them. ## Example ```bash curl -X PATCH 'https://api.sandbox.ovok.com/v1/email/templates/provider' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "provider": "brevo", "secret": "xkeysib-…" }' ```

Get application health GET

Returns the health of the Ovok backend and its Redis and FHIR store dependencies, together with build identity. Use it for liveness probes and as the source for a monitor that reads the response body. **Auth:** none. The route needs no bearer token. ## Behaviour - Also served at `/` and `/_health`. - Redis and FHIR store are probed in parallel. Each probe has a 2000 ms limit. A timeout or an error counts as `ok: false` for that dependency. - `ok` is `true` only when both `dependencies.redis.ok` and `dependencies.fhirStore.ok` are `true`. Email is not checked. - The HTTP status is always `200`, even when a dependency is down. Read `ok` and `dependencies` from the body. To get a non-2xx status on failure, use `GET /healthcheck/ready`. - `version`, `buildEnv`, `commitHash` and `buildDate` identify the build and are `null` when the build did not set them. `runningSince` is the process start time. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/healthcheck' ``` ```json { "ok": true, "dependencies": { "redis": { "ok": true }, "fhirStore": { "ok": true } }, "buildEnv": "production", "runningSince": "2026-04-12T17:21:21.410Z" } ```