Skip to content

GET /health

Returns the liveness status of the API service and its dependencies.

Overview

Use this endpoint to verify that the API service and its backing dependencies (database, Redis) are reachable. Suitable for load-balancer health checks or uptime monitors.

Authentication

None required. This endpoint is public.

Request

GET https://sapi.i18nme.com/health

No headers or query parameters needed.

Response

200 OK — all dependencies healthy

json
{
  "status": "ok",
  "db": "ok",
  "redis": "ok"
}

503 Service Unavailable — one or more dependencies degraded

json
{
  "status": "degraded",
  "db": "ok",
  "redis": "error"
}

Field reference

FieldTypeDescription
status"ok" | "degraded"Overall health state
db"ok" | "error"PostgreSQL connection check
redis"ok" | "error"Redis connection check

Example

bash
curl https://sapi.i18nme.com/health
js
const res = await fetch('https://sapi.i18nme.com/health')
const data = await res.json()
console.log(data.status) // "ok"
python
import httpx
r = httpx.get('https://sapi.i18nme.com/health')
print(r.json())  # {'status': 'ok', 'db': 'ok', 'redis': 'ok'}

i18nme is provided on a best-effort basis. While we strive for reliability and rapid issue resolution, no specific uptime, response time, or bug-fix timeframe is guaranteed.
Translation content and AI-generated output should be reviewed before production use.