System

System related endpoints.

Redirect to the API docs

get

https://api.obol.techhttp://localhost:3000https://localhost:3000

/

Hitting the root of the domain redirects to /docs and a swagger deployment.

Responses

200Success

application/json

objectOptional

get/

HTTPcURLJavaScriptPython

GET / HTTP/1.1
Host: api.obol.tech
Accept: */*

200Success

{}

Check the API health

get

https://api.obol.techhttp://localhost:3000https://localhost:3000

/v1/_health

This endpoint reports the API and its dependencies health.

Responses

200

The Health Check is successful

application/json

statusstringOptionalExample: ok

503

The Health Check is not successful

application/json

get/v1/_health

HTTPcURLJavaScriptPython

GET /v1/_health HTTP/1.1
Host: api.obol.tech
Accept: */*

{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}