Get the cluster health status

GET /_cat/health

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: HH:MM:SS, which is human-readable but includes no date information; Unix epoch time, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.

Required authorization

Cluster privileges: monitor

Query Parameters

Response

application/json

Examples

A successful response from GET /_cat/health?v=true&format=json. By default, it returns HH:MM:SS and Unix epoch timestamps.

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET /_cat/health?v=true&format=json

JavaScript Elasticsearch JavaScript Client

const response = await client.cat.health({
  v: "true",
  format: "json",
});

Python Elasticsearch Python Client

resp = client.cat.health(
    v=True,
    format="json",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_cat/health?v=true&format=json" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.cat().health();

PHP Elasticsearch PHP Client

$resp = $client->cat()->health([
    "v" => "true",
    "format" => "json",
]);

Ruby Elasticsearch Ruby Client

response = client.cat.health(
  v: "true",
  format: "json"
)

Response

[
  {
    "epoch": "1475871424",
    "timestamp": "16:17:04",
    "cluster": "elasticsearch",
    "status": "green",
    "node.total": "1",
    "node.data": "1",
    "shards": "1",
    "pri": "1",
    "relo": "0",
    "init": "0",
    "unassign": "0",
    "unassign.pri": "0",
    "pending_tasks": "0",
    "max_task_wait_time": "-",
    "active_shards_percent": "100.0%"
  }
]

Required authorization

Query Parameters { ts , h , s , }

Response

Query Parameters