Get the cluster health status

GET /_cluster/health/{index}
GET /_cluster/health

You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.

The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated. The index level status is controlled by the worst shard status.

One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. The cluster status is controlled by the worst index status.

Required authorization

Cluster privileges: monitor,manage

Path Parameters

index union IndexName | [] IndexName optional

Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.

Leave it out to use /_cluster/health.

Query Parameters

expand_wildcards string ExpandWildcards · default: all

Whether to expand wildcard expression to concrete indices that are open, closed or both.

Supported values include:

all: Match any data stream or index, including hidden ones.
open: Match open, non-hidden indices. Also matches any non-hidden data stream.
closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
none: Wildcard expressions are not accepted.

Values: all open closed hidden none

level enum Level · default: cluster

Can be one of cluster, indices or shards. Controls the details level of the health information returned.

Values: cluster indices shards

local boolean · default: false

If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

master_timeout string Duration · default: 30s

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

timeout string Duration · default: 30s

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

wait_for_active_shards WaitForActiveShards · default: 0

A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.

Values: all index-setting

wait_for_events enum WaitForEvents

Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.

Values: immediate urgent high normal low languid

wait_for_nodes number | string

The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation.

wait_for_no_initializing_shards boolean · default: false

A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards.

wait_for_no_relocating_shards boolean · default: false

A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards.

wait_for_status enum HealthStatus

One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status.

Supported values include:

green (or GREEN): All shards are assigned.
yellow (or YELLOW): All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.
red (or RED): One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.
unknown
unavailable

Values: green GREEN yellow YELLOW red RED unknown unavailable

Response

application/json

Examples

A successful response from GET _cluster/health. It is the health status of a quiet single node cluster with a single index with one shard and one replica.

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _cluster/health

JavaScript Elasticsearch JavaScript Client

const response = await client.cluster.health();

Python Elasticsearch Python Client

resp = client.cluster.health()

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_cluster/health" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.cluster().health(h -> h);

C# Elasticsearch .NET Client

var response = await client.Cluster.HealthAsync();

PHP Elasticsearch PHP Client

$resp = $client->cluster()->health();

Ruby Elasticsearch Ruby Client

response = client.cluster.health

Response

{
  "cluster_name" : "testcluster",
  "status" : "yellow",
  "timed_out" : false,
  "number_of_nodes" : 1,
  "number_of_data_nodes" : 1,
  "active_primary_shards" : 1,
  "active_shards" : 1,
  "relocating_shards" : 0,
  "initializing_shards" : 0,
  "unassigned_shards" : 1,
  "delayed_unassigned_shards": 0,
  "number_of_pending_tasks" : 0,
  "number_of_in_flight_fetch": 0,
  "task_max_waiting_in_queue_millis": 0,
  "active_shards_percent_as_number": 50.0
}

Required authorization

Path Parameters

Query Parameters { expand_wildcards , level , local , master_timeout , timeout , wait_for_active_shards , wait_for_events , wait_for_nodes , wait_for_no_initializing_shards , wait_for_no_relocating_shards , wait_for_status , }

Response

Query Parameters