Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mnah05-boiler-go-21-79.mintlify.app/llms.txt

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

The health endpoint verifies the status of database and Redis connections. It returns detailed status information along with response time metrics.

​
Endpoint

GET /health
Authentication: None required

​
Response

The endpoint returns HTTP 200 when all services are healthy, or HTTP 503 when any service is down.
​
status
object
required
Health status of each service
​
database
string
required
Database connection status - either “up” or “down”
​
redis
string
required
Redis connection status - either “up” or “down”
​
checked
string
required
UTC timestamp when the health check was performed
​
duration
integer
required
Time taken to perform the health check in milliseconds

​
Response examples

{
  "status": {
    "database": "up",
    "redis": "up"
  },
  "checked": "2026-03-03T14:32:15.123Z",
  "duration": 42
}

​
Example request

curl -X GET http://localhost:8080/health