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

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Query parameters

ts boolean · default: true

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

h union oneOf

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: 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 activeShardsPercent

s union oneOf

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.

One of: string[] or string

format string · default: text

Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

help boolean · default: false

When set to true will output available columns. This option can't be combined with any other query string option.

v boolean · default: false

When set to true will enable verbose output.

bytes enum

Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

Values: b kb mb gb tb pb

time enum

Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

Values: nanos micros ms s m h d

Response

application/json