API ReferenceHealth

Health

Application availability and diagnostic responses, without a database health query.

Status: complete · Source: content/docs/api-reference/health.mdx

These public diagnostics are direct Express routes. Paths follow the reference conventions; they have no /api prefix in the shared application. Neither route accepts or validates request parameters, queries PostgreSQL, or reports database/migration state.

Application health

GET/healthPublic

Confirm that a request reaches the Express application and receives its health response.

curl -i http://localhost:3001/health

HTTP 200:

{"status":"OK","message":"Server is working!"}

The local server.ts connects the shared Prisma client before listening, so a local response also means the initial connection completed. The route does not check ongoing database connectivity or applied migrations. The serverless wrappers do not run that startup gate. See Backend Quickstart and Deployment & Configuration.

Diagnostic response

GET/testPublic

Confirm that the Express diagnostic route is reachable.

HTTP 200:

{"message":"API is working!"}

This response has no additional dependency checks. Both diagnostics still pass through the global middleware; rate limiting can return 429 before either route responds. There is no route-specific error branch or database-failure response on these checks.

Sourcebackend/src/app.ts

Sourcebackend/src/server.ts

Last updated · Edit this page on GitHub

On this page