Endpoints

Health for Laravel registers 7 endpoints under a configurable prefix (default: /health).

Available Endpoints

Response Codes

The liveness, readiness and startup endpoints return:

• 200 — all checks pass (status ok or warning)
• 503 — one or more checks are critical or unknown

The status, Prometheus and JSON endpoints always return 200 once the request is authorized; the health state is in the body. A request that fails the IP allowlist or authentication gets 403 (see Endpoint Security).

See Architecture for which checks each endpoint runs.

Customizing Paths

Override any path in config/health.php:

'endpoints' => [
    'prefix' => env('HEALTH_PREFIX', 'health'),
    'readiness' => ['path' => '/readyz', 'enabled' => true],
],

Hostname Identification

The /health/metrics/json endpoint includes a top-level hostname field and /health/status includes app.hostname, identifying which host or pod served the request. The dashboard shows it in its header. This is essential in horizontally scaled deployments where a load balancer routes to any instance.

The liveness, readiness, and startup probe endpoints intentionally omit the hostname to stay lightweight.

Disabling Endpoints

Set enabled to false for any endpoint you don't need:

'endpoints' => [
    'metrics' => ['path' => '/metrics', 'enabled' => false],
],

A disabled endpoint has no route, so requests to its path get a 404. The Prometheus endpoint can also be switched off with HEALTH_PROMETHEUS_ENABLED=false, and HEALTH_ENABLED=false removes every health route.

Related Documentation

• Configuration Reference
• Endpoint Security
• Kubernetes Probes