OBobol
System

Check the API health

Changed on

This endpoint reports the API and its dependencies health.

get/v1/_health

Request

  • Base URL
    https://api.obol.tech
  • Auth
    none declared

Response

The Health Check is successful

statusstring
infoobject nullable
errorobject nullable
detailsobject

Example response

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

Changes

  • 3896d3513a5dRevision changes
    • info

      api operation id HealthController_check removed and replaced with HealthController_check_v1

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

  • 52d1f82e219eRevision changes
    • info

      endpoint added