Interface: HealthConfigShape

The health config, authored under the health key of config/app.ts.

Properties

optional enabled?: boolean

Serve the endpoint. Default: on outside production, off in production.

optional path?: string

Route path. Default: /health.

optional secret?: string

Shared secret. Required in production; supplied via ?key= or X-Health-Key.

optional showDetails?: boolean

Include per-check details. Set false for a bare { status } body. Default: true.