Health Check
Environment variables are configurable for Directus Enterprise Cloud projects via our Customer Success team. You can also set environment variables in self-hosted projects.
The health check service powers the /server/health endpoint, which reports the status of connected services like the database, Redis, storage, and email. Results are cached and shared across requests to avoid excessive checks. In multi-instance deployments, the cached result is shared across all instances.
The endpoint requires authentication. Unauthenticated requests receive a 403 error, non-admin users receive only the overall status, and admin users receive the result of each individual check. For unauthenticated liveness checks, use /server/ping instead. See Health Checks for details.
| Variable | Description | Default Value |
|---|---|---|
HEALTHCHECK_ENABLED | Whether or not to enable the /server/health endpoint. | true |
HEALTHCHECK_NAMESPACE | Namespace used for health check cache keys to prevent conflicts with other cached data. | directus:healthcheck |
HEALTHCHECK_SERVICES | Comma-separated list of services to check. Supported values: database, redis, storage, email. | database,redis,storage,email |
HEALTHCHECK_CACHE_TTL | How long the cached health check result is valid before services are re-checked. | 5m |
Including
redis or email in HEALTHCHECK_SERVICES does not guarantee they are checked:redisis only checked when Redis is configured (seeREDIS_ENABLED).emailis only checked whenEMAIL_VERIFY_SETUPistrue.
Individual services also support their own health check threshold configuration. See Database, Cache, Files, and Security & Limits for *_HEALTHCHECK_THRESHOLD variables.
Get once-a-month release notes & real‑world code tips...no fluff. 🐰