System

System related endpoints.

Redirect to the API docs

get

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.obol.tech//'

200

200

{}

Check the API health

get

This endpoint reports the API and its dependencies health.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.obol.tech//v1/_health'

200

503

200

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

The Health Check is successful