Nexus API Reference

LivenessHandler

in package

• Application

Tags

psalm-api

Opaque liveness endpoint safe to expose publicly (load balancers, Kubernetes livenessProbe). It reports ONLY the aggregate up/down state — never check names, per-check details, or exception messages — so it cannot leak internal topology or component/error information.

$app->get('/livez', new LivenessHandler($registry));

Response: 200 {"status":"up"} — no check is down 503 {"status":"down"} — at least one check is down

For the detailed component view (check states, controlled error detail), use HealthCheckHandler on an INTERNAL or authenticated route. A check that throws is treated as down; this handler never throws.

Table of Contents

Methods

__construct()  : mixed

__invoke()  : ResponseInterface