---
title: "Health check endpoint"
method: GET
path: "/health"
tags: ["Health"]
---

# Health check endpoint

`GET /health`

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.

## Response `200`

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

- object
  - `status` string — The overall health status of the system.
  - `details` object — Detailed health status for each connected cryptocurrency node.

## Other responses

- `503` — Service Unavailable. One or more nodes are not synchronized or unavailable.

## Changes

- **2024-11-25** `32a04b45196c` — 1 info
  - api tag `Health` added
- **2024-11-25** `6b9539137e6a` — 3 info
  - added the non-success response with the status `503`
  - added the optional property `details` to the response with the `200` status
  - added the optional property `status` to the response with the `200` status
- **2024-11-18** `b5092f204599` — 2 warning, 2 info
  - removed the optional property `details` from the response with the `200` status
  - removed the optional property `status` from the response with the `200` status
  - api tag `Health` removed
  - removed the non-success response with the status `503`

[Change history](https://skmtc.dev/btcpayserver/apis/nbxplorer-api/changes/health/get.md)

---

[API](https://skmtc.dev/btcpayserver/apis/nbxplorer-api.md) · [All operations](https://skmtc.dev/btcpayserver/apis/nbxplorer-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/btcpayserver/nbxplorer-api/revisions/208cac39e31a/schema)