﻿---
title: stack es cluster health cli command
description: Get the cluster health status. Behaviour flags: --dry-run — validate all inputs and exit without performing any action 
url: https://www.elastic.co/elastic/docs-builder/docs/4097/reference/elastic-cli/cli/stack/es/cluster/health
applies_to:
  - Elastic Cloud Serverless: Preview
  - Elastic Stack: Preview
---

# stack es cluster health cli command
<cli-modifiers>
</cli-modifiers>

```bash
elastic stack es cluster health [options]
```

Get the cluster health status.
**Behaviour flags:**
`--dry-run` — validate all inputs and exit without performing any action

## Options

<definitions>
  <definition term="--expand-wildcards enum">
    Expand wildcard expression to concrete indices that are open, closed or both.
    **Values:** all, open, closed, hidden, none
    **Repeatable:** pass `--expand-wildcards` multiple times to supply more than one value
  </definition>
  <definition term="--level enum">
    Return health information at a specific level of detail.
    **Values:** cluster, indices, shards
  </definition>
  <definition term="--local">
    If true, retrieve information from the local node only.
    If false, retrieve information from the master node.
  </definition>
  <definition term="--master-timeout string">
    The 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.
  </definition>
  <definition term="--timeout string">
    The period to wait for a response.
    If no response is received before the timeout expires, the request fails and returns an error.
  </definition>
  <definition term="--wait-for-active-shards string">
    Wait for the specified number of active shards.
    Use `all` to wait for all shards in the cluster to be active.
    Use `0` to not wait.
  </definition>
  <definition term="--wait-for-events enum">
    Wait until all currently queued events with the given priority are processed.
    **Values:** immediate, urgent, high, normal, low, languid
  </definition>
  <definition term="--wait-for-nodes string">
    Wait until the specified number (N) of nodes is available.
    It also accepts `>=N`, `<=N`, `>N` and `<N`.
    Alternatively, use the notations `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)`.
  </definition>
  <definition term="--wait-for-no-initializing-shards">
    Wait (until the timeout expires) for the cluster to have no shard initializations.
    If false, the request does not wait for initializing shards.
  </definition>
  <definition term="--wait-for-no-relocating-shards">
    Wait (until the timeout expires) for the cluster to have no shard relocations.
    If false, the request not wait for relocating shards.
  </definition>
  <definition term="--wait-for-status enum">
    Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status).
    A green status is better than yellow and yellow is better than red.
    By default, the request does not wait for a particular status.
    **Values:** green, yellow, red, unknown, unavailable
  </definition>
  <definition term="--index string">
    A comma-separated list of data streams, indices, and index aliases that limit the request.
    Wildcard expressions (`*`) are supported.
    To target all data streams and indices in a cluster, omit this parameter or use _all or `*`.
    **Repeatable:** pass `--index` multiple times to supply more than one value
  </definition>
  <definition term="--error-trace">
    When set to `true` Elasticsearch will include the full stack trace of errors
    when they occur.
  </definition>
  <definition term="--filter-path string">
    Comma-separated list of filters in dot notation which reduce the response
    returned by Elasticsearch.
    **Repeatable:** pass `--filter-path` multiple times to supply more than one value
  </definition>
  <definition term="--human">
    When set to `true` will return statistics in a format suitable for humans.
    For example `"exists_time": "1h"` for humans and
    `"exists_time_in_millis": 3600000` for computers. When disabled the human
    readable values will be omitted. This makes sense for responses being consumed
    only by machines.
  </definition>
  <definition term="--pretty">
    If set to `true` the returned JSON will be "pretty-formatted". Only use
    this option for debugging only.
  </definition>
  <definition term="--input-file string">
    path to a JSON file to use as command input
  </definition>
  <definition term="--dry-run">
    validate all inputs and exit without performing any action (preview changes without applying them)
  </definition>
</definitions>


## Global Options

<definitions>
  <definition term="--json">
    output as JSON
  </definition>
</definitions>