Health Check
GET /health
Returns the health status of the API service and its database connection.
No authentication required
This endpoint is intentionally unauthenticated — it is used by Docker and Portainer healthchecks.
Response
200 OK — healthy
{
"status": "ok",
"uptime": 3600
}
503 Service Unavailable — database unreachable
{
"status": "error",
"uptime": 3600
}
| Field | Type | Description |
|---|---|---|
status | "ok" | "error" | Whether the service and database are reachable |
uptime | number | Process uptime in seconds |
Example
curl https://api.guacamoleninja.com/health