Health Check

Get the health of the service

Check the health of the service. This checks the read and write health of the database and cache.

get/v1/health-check

Request

  • Base URL: https://data-api.avax.network
  • URL: https://data-api.avax.network/v1/health-check
  • Auth: one of:
    • API key in header x-glacier-api-key
    • none

Response

The health of the service. This checks the read and write health of the database and cache.

status'error' | 'ok' | 'shutting_down'
infoobject nullable
errorobject nullable
detailsobject

Example response

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

Changes

No recorded changes to this operation across all 3 revisions of this API.