Health
Health check configuration. Value is a string (shorthand for HTTP path) or an object.
A string shorthand (health: /health) expands to { path: "/health" }.
| Field | Type | Description |
|---|---|---|
path |
string |
HTTP path to check |
command |
string |
Shell command for non-HTTP checks |
interval |
string |
Check interval (e.g. 30s, 1m) |
timeout |
string |
Timeout per check attempt |
retries |
integer |
Consecutive failures before unhealthy (min: 1) |
start_period |
string |
Grace period before failures count |
Use path for HTTP checks or command for exec checks. If both are present, path takes precedence.
health:
path: /api/private/config
start_period: 30s
retries: 3Real-world examples: See health check patterns in Metabase (custom path + timing) and Ghost (simple path). Browse all apps →