GET
/docs/
Help docs
This page. Lists all available routes, environment variables, and links to detailed docs for each area.
Core routes
GET /healthGET /db/healthGET /tenant/*
Documentation routes
GET /docs/GET /docs/healthGET /docs/db-health
GET
/health
Service health
Returns the service status and deployment timestamp. No authentication required.
Request
Nothing required. No headers, body, or query parameters.
Response
{
"service": "sample",
"status": "ok",
"deployed_at": "unknown"
}
GET
/db/health
Database health
Verifies the API can acquire a connection from the MySQL pool and execute a query. Returns 503 if the connection fails.
Request
Nothing required. No headers, body, or query parameters.
Response
{
"service": "sample",
"status": "ok",
"deployed_at": null,
"message": "Database connection successful",
"database": "your_db"
}
Returns 503 with "status": "error" when the connection fails.