Health

Health check endpoint

Changed on Sep 29, 2026

Performs a health check of NBXplorer and its connected nodes. This endpoint can be used without authentication. Healthy and degraded results return HTTP 200; unhealthy results return HTTP 503.

get/health

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
none required
TypeScript
https://skmtc.dev/btcpayserver/apis/nbxplorer-api/docs/health/get.ts
A function with typed inputs. Its response is checked against the schema.

Response

The service is healthy or degraded. A degraded result indicates that at least one node is unavailable.

status'Healthy' | 'Degraded' | 'Unhealthy' required

resultsobject required

Changes

Sep 29, 202652231f42c765 Revision changes
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  added the new Degraded enum value to the response property for the response status
- warning
  added the new Degraded enum value to the response property for the response status
- warning
  added the new Healthy enum value to the response property for the response status
- warning
  added the new Healthy enum value to the response property for the response status
- warning
  added the new Unhealthy enum value to the response property for the response status
- warning
  added the new Unhealthy enum value to the response property for the response status
- info
  api operation id GetHealth was added
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Nov 25, 202432a04b45196c Revision changes
- info
  api tag Health added

Operation history (4 revisions)

Health check endpoint

Request

Response 200OK

Changes

Response