Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/eggarcia98/auth-backend/llms.txt

Use this file to discover all available pages before exploring further.

GET /health Returns the current health status of the server. This endpoint does not require authentication and is used by load balancers, container orchestration platforms (such as Docker Compose and Kubernetes), and monitoring systems to confirm the service is alive.
This endpoint is registered at the root path, not under /api/v1/auth. The full URL is http://your-host/health.

​
Request

No parameters or authentication required.

​
Response

​
status
string
Always "ok" when the server is healthy.
​
timestamp
number
Unix timestamp (milliseconds) at the time of the request. Useful for confirming the response is fresh.

​
Examples

curl https://your-api.example.com/health

​
Success response (200)

{
  "status": "ok",
  "timestamp": 1705312200000
}

​
Usage in Docker

The included docker-compose.yml uses this endpoint for its built-in health check: 
healthcheck:
  test: ["CMD", "node", "-e", "require('http').get('http://localhost:8080/health', (r) => process.exit(r.statusCode === 200 ? 0 : 1))"]
  interval: 30s
  timeout: 10s
  retries: 3
  start_period: 40s
See the Docker deployment guide for more details.

Build docs developers (and LLMs) love

Get started for freeTalk to us