Cluster health #

Returns the cluster health for quick overview.

Get the whole cluster health #

Requests #

GET /_cluster/health

Query Parameters #

• level
  (Optional, string) Can be one of cluster, regions, collections rollings or shards. Controls the details level of the health information returned. Defaults to cluster.

Get the health of a specific region #

Requests #

GET /_cluster/_region/<region_id>/health

Path parameters #

• region_id
  (Required, String) The UUID of the region you want to query. A special ID _local can be specified to query the state of the region that handles this request.

Query Parameters #

• level
  (Optional, string) Can be one of regions, collections rollings or shards. Controls the details level of the health information returned. Defaults to regions.