Sign in
Health

Health check endpoint

Performs a health check of NBXplorer and its connected nodes. This endpoint can be used without authentication and returns HTTP 200 if all nodes are ready and synchronized.

get/health

Response

System is healthy. All nodes connected to NBXplorer are ready and synchronized.

statusstring

The overall health status of the system.

detailsobject

Detailed health status for each connected cryptocurrency node.

Example response

{
  "status": "healthy"
}

Changes

Changed in 3 of the 40 revisions of this API.26

  • 32a04b45196c1See the full diff
    • ○

      api tag Health added

      api-tag-added

  • 6b9539137e6a3See the full diff
    • ○

      added the non-success response with the status 503

      response-non-success-status-added

    • ○

      added the optional property details to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 200 status

      response-optional-property-added

  • b5092f20459922See the full diff
    • ●

      removed the optional property details from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property status from the response with the 200 status

      response-optional-property-removed

    • ○

      api tag Health removed

      api-tag-removed

    • ○

      removed the non-success response with the status 503

      response-non-success-status-removed

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog