v1

latestOpenAPI 3.1.02026-07-175793186.0 KB

health

Ready

Report whether critical startup dependencies are ready for requests.

Verifies DB connectivity with a short-timeout ping so a sleeping Neon compute reports degraded instead of ready.

get/ready

Successful Response

readyboolean required

Whether critical startup dependencies are ready.

planner'ready' | 'missing' required

Planner readiness classification.

database'ready' | 'missing' | 'disabled' | 'degraded' required

Database readiness classification for persistence-backed features.

database_requiredboolean required

Whether the current server configuration requires database availability.

sandbox_providerstring required

Active sandbox backend selected for runtime execution.