Get the cluster health status
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.
curl \
-X GET http://api.example.com/_cat/health
[
{
"": 42.0,
"timestamp": "string",
"cluster": "string",
"status": "string",
"node.total": "string",
"node.data": "string",
"shards": "string",
"pri": "string",
"relo": "string",
"init": "string",
"unassign.pri": "string",
"unassign": "string",
"pending_tasks": "string",
"max_task_wait_time": "string",
"active_shards_percent": "string"
}
]