Skip to main content

Get health status

MethodPath
GET/v1/slim/health

Authentication · Access policies

Returns the health of the Slim API and the systems it depends on. Use it for uptime checks and status screens.

Auth: none.

Behaviour​

  • status is healthy when both Medplum and Redis are up, degraded when one is down, and unhealthy when both are down. The route still answers 200 in every case, so read status, not the HTTP code.
  • externalSystems.medplum and externalSystems.redis hold each system's own status and, when available, its version, memory and connection figures. responseTimeMs is the time Medplum took to answer its health check.
  • cache holds hit, miss and error counts of the application cache since the process started.
  • ovok, system and the Medplum serverMetrics come from the monitoring system, from the last 5 minutes. They are left out when monitoring is not configured or does not answer.
  • uptimeSeconds is the time since this process started. version is null when the deployment does not set one.

Example​

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/health'

Successful response​

200 — Health of the Slim API and the systems it depends on.