OVOK DOCS
Get startedOvokSignalsSDKsGuidesAPI referenceDeveloper resources
Healthcheck

Check CMS health

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

Checks whether the backend can reach the CMS.

Auth: none. The route needs no bearer token.

Behaviour

  • Calls the CMS's own health endpoint, GET /api/_ovok/health. ok is true only when it answers 200 with status: "ok", which it does once it has read its database.
  • ok is false when the CMS answers anything else, cannot be reached, takes longer than 2 seconds, or no CMS URL is configured.
  • The status is 200 in every case.

Example

curl -X GET 'https://api.sandbox.ovok.com/healthcheck/cms'
{ "ok": true }

Response Body

CMS health status.

Example Request
curl -X GET 'https://api.sandbox.ovok.com/healthcheck/cms'
Example Response
Empty

Check FHIR store health GET

Checks whether the backend can reach the FHIR store and returns the FHIR store's own health report. Its old paths, `GET /healthcheck/fhir-store` and `GET /healthcheck/medplum`, answer `301` with `Location: /healthcheck/fhir`. **Auth:** none. The route needs no bearer token. ## Behaviour - Calls the FHIR store's `healthcheck` endpoint and returns `ok`, `version`, `platform`, `runtime`, `postgres` and `redis` from its answer. - When the call fails, the route still answers `200`, with `ok`, `postgres` and `redis` set to `false` and `version`, `platform` and `runtime` set to empty strings. - Unlike `GET /healthcheck`, this probe has no time limit of its own. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/healthcheck/fhir' ```

Check Signals health GET

Checks whether the backend can reach Signals. **Auth:** none. The route needs no bearer token. ## Behaviour - Calls Signals' own `GET /health`. `ok` is `true` only when Signals answers with `ok: true`, which it does while its database answers. - `ok` is `false` when Signals reports `ok: false`, cannot be reached, takes longer than 2 seconds, or no Signals URL is configured. - The status is `200` in every case. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/healthcheck/signals' ``` ```json { "ok": true } ```