OVOK DOCS
Get startedOvokSignalsSDKsGuidesAPI referenceDeveloper resources
Healthcheck

Check email service health

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

Reports the email service status.

Auth: none. The route needs no bearer token.

Behaviour

  • Contacts nothing. It always answers { "ok": true, "skipped": true }, so the result says nothing about whether email delivery works.
  • GET /healthcheck does not include email for the same reason.

Example

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

Response Body

Email health status.

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

Check email service health GET

Reports the email service status. **Auth:** none. The route needs no bearer token. ## Behaviour - Contacts nothing. It always answers `{ "ok": true, "skipped": true }`, so the result says nothing about whether email delivery works. - `GET /healthcheck` does not include email for the same reason. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/healthcheck/email' ```

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' ```