Configuration
Health Check
Configuration for the server health check service.
Environment Variables
Environment variables are configurable for Directus Enterprise Cloud projects via our Customer Success team. You can also set environment variables in self-hosted projects.
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, edis, storage, and email. Results are cached and shared across requests to avoid excessive checks.
| 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 |
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. 🐰