LocaloyDevelopers
Open Network APIv1

Health check

Report whether the Open Network API and its dependencies are up. No API key needed.

GET{BASE_URL}/health

Checks the API's database and cache. Use it for uptime monitoring. It needs no API key and is not recorded in your request log, but it does count toward the per-IP rate limit.

Response

data.statusstringrequired
ok when every service is healthy, otherwise unavailable.
data.services.databasestringrequired
healthy or unhealthy.
data.services.redisstringrequired
healthy or unhealthy.

Status codes#

StatusMeaning
200Every service is healthy.
503At least one service is unhealthy. The body still lists each one.
cURL
curl "$LOCALOY_BASE_URL/health"
Response · 200
{
  "success": true,
  "data": {
    "status": "ok",
    "services": { "database": "healthy", "redis": "healthy" }
  }
}
Response · 503
{
  "success": false,
  "data": {
    "status": "unavailable",
    "services": { "database": "healthy", "redis": "unhealthy" }
  }
}