Get the cluster health status Generally available

GET /_cat/health
Api key auth Basic auth Bearer auth

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

  • time string

    The unit used to display time values.

    Values are nanos, micros, ms, s, m, h, or d.

  • ts boolean

    If true, returns HH:MM:SS and Unix epoch timestamps.

  • h string | array[string]

    A comma-separated list of columns names to display. It supports simple wildcards.

    Supported values include:

    • epoch (or t, time): The number of seconds since 1970-01-01 00:00:00.
    • timestamp (or ts, hms, hhmmss): The time in HH:MM:SS format.
    • cluster (or cl): The cluster name.
    • status (or st): The health status.
    • node.total (or nt, nodeTotal): The total number of nodes that can store data.
    • node.data (or nd, nodeData): The number of nodes that can store data.
    • shards (or t, sh, shards.total, shardsTotal): The total number of shards.
    • pri (or p, shards.primary, shardsPrimary): The number of primary shards.
    • relo (or r, shards.relocating, shardsRelocating): The number of relocating nodes.
    • init (or i, shards.initializing, shardsInitializing): The number of initializing nodes.
    • unassign (or u, shards.unassigned, shardsUnassigned): The number of unassigned shards.
    • unassign.pri (or up, shards.unassigned.primary, shardsUnassignedPrimary): The number of unassigned primary shards.
    • pending_tasks (or pt, pendingTasks): The number of pending tasks.
    • max_task_wait_time (or mtwt, maxTaskWaitTime): The wait time of the longest pending task.
    • active_shards_percent (or asp, activeShardsPercent): The percentage of active shards.

    Values are epoch, t, time, timestamp, ts, hms, hhmmss, cluster, cl, status, st, node.total, nt, nodeTotal, node.data, nd, nodeData, shards, sh, shards.total, shardsTotal, pri, p, shards.primary, shardsPrimary, relo, r, shards.relocating, shardsRelocating, init, i, shards.initializing, shardsInitializing, unassign, u, shards.unassigned, shardsUnassigned, unassign.pri, up, shards.unassigned.primary, shardsUnassignedPrimary, pending_tasks, pt, pendingTasks, max_task_wait_time, mtwt, maxTaskWaitTime, active_shards_percent, asp, or activeShardsPercent.

  • s string | array[string]

    List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object

    • epoch number | string

      seconds since 1970-01-01 00:00:00

      One of:
      UnitSeconds number string-2 string

      seconds since 1970-01-01 00:00:00

      seconds since 1970-01-01 00:00:00

    • timestamp string

      time in HH:MM:SS

    • cluster string

      cluster name

    • status string

      health status

    • node.total string

      total number of nodes

    • node.data string

      number of nodes that can store data

    • shards string

      total number of shards

    • pri string

      number of primary shards

    • relo string

      number of relocating nodes

    • init string

      number of initializing nodes

    • unassign.pri string

      number of unassigned primary shards

    • unassign string

      number of unassigned shards

    • pending_tasks string

      number of pending tasks

    • max_task_wait_time string

      wait time of longest task pending

    • active_shards_percent string

      active number of shards in percent
GET /_cat/health 
GET /_cat/health?v=true&format=json

resp = client.cat.health(
    v=True,
    format="json",
)
const response = await client.cat.health({
  v: "true",
  format: "json",
});
response = client.cat.health(
  v: "true",
  format: "json"
)
$resp = $client->cat()->health([
    "v" => "true",
    "format" => "json",
]);
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/health?v=true&format=json"
client.cat().health();
Response examples (200)
A successful response from `GET /_cat/health?v=true&format=json`. By default, it returns `HH:MM:SS` and Unix epoch timestamps. 
[
  {
    "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%"
  }
]