Skip to main content
GET
/
api
/
v1
/
health
cURL
curl -sS \
  -H 'Authorization: Bearer $OXI_SK' \
  'https://api.0xinsider.com/api/v1/health'
{
  "object": "health",
  "data": {
    "status": "ok"
  },
  "meta": {
    "request_id": "req_example",
    "cached": false
  }
}
A liveness probe. Returns 200 with database and cache status when the API is up. No auth required, so it works as a smoke test from CI or a status dashboard.
curl https://api.0xinsider.com/api/v1/health
{
  "object": "health",
  "data": { "status": "ok", "db": true, "cache": true },
  "meta": { "request_id": "req_abc123", "cached": false }
}

Headers

If-None-Match
string

Conditional GET validator from a previous ETag. Matching values return 304 Not Modified with an empty body.

Response

Health status

object
string
required
Allowed value: "health"
data
object
required
meta
object
required