Health check

Returns the operational health of the Parmana service. Always returns status: “UP” unconditionally. See the response schema description for exactly what this endpoint does and does not check.

One of two routes exempt from caller authentication (the other is GET /openapi.yaml). Liveness probes must be able to reach it with no credential, see packages/api/src/app.ts (mounted ahead of the caller-auth middleware).

GET /health

Health check

cURL

curl --request GET \
  --url http://localhost:3000/health

200

{
  "status": "UP"
}

Response

200 - application/json

Service health information.

Response returned by GET /health. The route unconditionally returns status: "UP"; it does not check storage, policy, or any dependent component; a 200 response means only that the Express process is handling requests.

status · enum<string> · required

Available options: UP