---
title: "GET /cluster_health"
method: GET
path: "/cluster_health"
---

# GET /cluster_health

`GET /cluster_health`

Checks the full graph. Returns a binary OK or not OK.

## Response `200`

Healthy cluster

- ClusterHealthResults
  - `OK` boolean, required
  - `nodesHealthy` string[]
  - `nodesUnhealthy` string[]
  - `nodesTotal` integer
  - `generated-at` string, date-time
  - `duration-ns` integer

## Other responses

- `418` — Unhealthy cluster

## Changes

- **2021-03-12** `a9ada0ba4063` — 2 info
  - added the non-success response with the status `418`
  - removed the non-success response with the status `503`
- **2021-03-12** `55fbabd33ee9` — 1 info
  - endpoint added
- **2018-12-04** `ddb05d6142ba` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/bloomberg/apis/goldpinger/changes/cluster_health/get.md)

---

[API](https://skmtc.dev/bloomberg/apis/goldpinger.md) · [All operations](https://skmtc.dev/bloomberg/apis/goldpinger/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bloomberg/goldpinger/revisions/03e2927054ca/schema)
