---
title: "Get cluster health report."
method: GET
path: "/v4/cluster/health"
tags: ["Cluster"]
---

# Get cluster health report.

`GET /v4/cluster/health`

Cluster health report.

## Query parameters

- `issues_only` boolean

## Response `200`

Cluster report is ready see detailed information.

- ClusterHealthReport — Cluster health report.
  - `active_alerts` Alert[], required
    - `active_since` string, date-time, required — Since what time the alert is active
    - `name` string, required — Alert name
    - `severity` string — Severity level of the alert
    - `threshold` string — Threshold for the alert
  - `certificates` Certificate[], required — List of certificates in the cluster
    - `expired` boolean, required — Whether the certificate has expired
    - `type` string, required — Certificate type
    - `valid_until` string, date-time, required — Certificate expiration time
  - `database_infos` DatabaseInfo[], required
    - `detailed_status` 'active' | 'active-change-pending' | 'pending' | 'import-pending' | 'delete-pending' | 'recovery' | 'creation-failed' | 'unknown', required — The database detailed status
    - `high_availability` HighAvailability, required
      - `status` 'down' | 'up' | 'disabled', required — The high availability status
    - `id` string, required — DB id
    - `name` string, required — DB name
    - `status` 'active' | 'warning' | 'down', required — Database status
    - `version` string, required — DB version
  - `fqdn` string, required — Cluster FQDN
  - `license` LicenseHealthReport, required — License health report.
    - `expired` boolean, required — Whether the license has expired
    - `flex_shards_in_use` integer, required — Number of Flex shards in use by databases in the cluster
    - `flex_shards_limit` integer, required — Flex shards limit specified in cluster license
    - `ram_shards_in_use` integer, required — Number of RAM shards in use by databases in the cluster
    - `ram_shards_limit` integer, required — RAM shards limit specified in cluster license
    - `shards_in_use` integer, required — Accumulated number of shards in use by databases in the cluster
    - `shards_limit` integer, required — Shards limit specified in cluster license
    - `valid_until` string, date-time, required — License expiration time
  - `nodes` NodeHealthReport[], required — List of nodes in the cluster
    - `active_alerts` Alert[]
      - `active_since` string, date-time, required — Since what time the alert is active
      - `name` string, required — Alert name
      - `severity` string — Severity level of the alert
      - `threshold` string — Threshold for the alert
    - `detailed_status` 'down' | 'provisioning' | 'decommissioning' | 'active', required — Node detailed status
    - `ephemeral_memory_path` string, required — Path to ephemeral storage on the node
    - `ephemeral_memory_size` number, double, required — Size of ephemeral storage on the node in bytes
    - `id` string, required — Node id
    - `in_maintenance` boolean, required — Whether the node is in maintenance mode
    - `memory` Memory, required — Memory information
      - `free_provisional_ram` integer, required — Remaining ram for provisioning new shards on the node
      - `free_ram` integer, required — Free ram the node has in bytes
      - `overbooking_depth` integer, required — How much the node is overbooked or has capacity remaining, like free provisional ram but takes into account shards_overbooking (can be negative if it is overbooked)
      - `total_provisional_ram` integer, required — Total ram for provisioning shards on the node
      - `total_ram` integer, required — Total ram the node has in bytes
    - `observed_at` integer, required — Unix time in seconds when the value was last written in the CCS
    - `persistent_memory_path` string, required — Path to persistent storage on the node
    - `persistent_memory_size` number, double, required — Size of persistent storage on the node in bytes
    - `quorum_only` boolean, required — Whether the node is quorum-only (does not accept servers)
    - `role` 'leader' | 'follower', required — Node role can be leader or follower
    - `services` Service[], required
      - `name` string, required — Name of the service
      - `status` string, required — Status of the service corresponding to the statename returned by supervisor
    - `shards` ShardHealthReport[], required — Shards on the node.
      - `detailed_status` 'ok' | 'importing' | 'timeout' | 'loading' | 'busy' | 'down' | 'trimming' | 'unknown' | 'role_mismatch', required — shard detailed status
      - `id` string, required
      - `role` 'leader' | 'follower', required — shard role can be leader or follower
      - `status` 'active' | 'inactive' | 'trimming', required — shard status can be up or trimming
    - `status` 'down' | 'warning' | 'active', required — Node status
    - `version` string, required — RS version installed on the node
  - `status` 'error' | 'warning' | 'ok', required — Cluster status

## Other responses

- `404` — Not Found
- `503` — Service Unavailable

## Changes

- **2026-05-15** `7bc7a18e3b20` — 1 warning
  - added the new `role_mismatch` enum value to the `nodes/items/shards/items/detailed_status` response property for the response status `200`
- **2026-02-09** `17b61f8beeda` — 1 info
  - endpoint added
- **2026-01-23** `9fdf3bc7ad77` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/redis/apis/redis-software-rest-api/changes/v4/cluster/health/get.md)

---

[API](https://skmtc.dev/redis/apis/redis-software-rest-api.md) · [All operations](https://skmtc.dev/redis/apis/redis-software-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/redis/redis-software-rest-api/revisions/caec2005b95b/schema)