Get the cluster health | Elasticsearch API documentation

Query parameters

timeoutstring
Explicit operation timeout.
Values are -1 or 0.
verboseboolean
Opt-in for more information about the health of the system.
sizenumber
Limit the number of affected resources the health report API returns.

Responses

200 application/json
Hide response attributes Show response attributes object
- cluster_namestring Required
- indicatorsobject Required
  Hide indicators attributes Show indicators attributes object
  master_is_stableobject
  MASTER_IS_STABLE
  Hide master_is_stable attributes Show master_is_stable attributes object
  statusstring Required
  Values are green, yellow, red, or unknown.
  symptomstring Required
  impactsarray[object]
  Hide impacts attributes Show impacts attributes object
  descriptionstring Required
  idstring Required
  impact_areasarray[string] Required
  Values are search, ingest, backup, or deployment_management.
  severitynumber Required
  diagnosisarray[object]
  Hide diagnosis attributes Show diagnosis attributes object
  idstring Required
  actionstring Required
  affected_resourcesobject Required
  causestring Required
  help_urlstring Required
  detailsobject
  Hide details attributes Show details attributes object
  current_masterobject Required
  Hide current_master attributes Show current_master attributes object
  name
  node_id
  recent_mastersarray[object] Required
  exception_fetching_historyobject
  Hide exception_fetching_history attributes Show exception_fetching_history attributes object
  messagestring Required
  stack_tracestring Required
  cluster_formationarray[object]
  shards_availabilityobject
  SHARDS_AVAILABILITY
  Hide shards_availability attributes Show shards_availability attributes object
  statusstring Required
  Values are green, yellow, red, or unknown.
  symptomstring Required
  impactsarray[object]
  Hide impacts attributes Show impacts attributes object
  descriptionstring Required
  idstring Required
  impact_areasarray[string] Required
  Values are search, ingest, backup, or deployment_management.
  severitynumber Required
  diagnosisarray[object]
  Hide diagnosis attributes Show diagnosis attributes object
  idstring Required
  actionstring Required
  affected_resourcesobject Required
  causestring Required
  help_urlstring Required
  detailsobject
  Hide details attributes Show details attributes object
  creating_primariesnumber Required
  creating_replicasnumber Required
  initializing_primariesnumber Required
  initializing_replicasnumber Required
  restarting_primariesnumber Required
  restarting_replicasnumber Required
  started_primariesnumber Required
  started_replicasnumber Required
  unassigned_primariesnumber Required
  unassigned_replicasnumber Required
  diskobject
  DISK
  Hide disk attributes Show disk attributes object
  statusstring Required
  Values are green, yellow, red, or unknown.
  symptomstring Required
  impactsarray[object]
  Hide impacts attributes Show impacts attributes object
  descriptionstring Required
  idstring Required
  impact_areasarray[string] Required
  Values are search, ingest, backup, or deployment_management.
  severitynumber Required
  diagnosisarray[object]
  Hide diagnosis attributes Show diagnosis attributes object
  idstring Required
  actionstring Required
  affected_resourcesobject Required
  causestring Required
  help_urlstring Required
  detailsobject
  Hide details attributes Show details attributes object
  indices_with_readonly_blocknumber Required
  nodes_with_enough_disk_spacenumber Required
  nodes_over_high_watermarknumber Required
  nodes_over_flood_stage_watermarknumber Required
  nodes_with_unknown_disk_statusnumber Required
  repository_integrityobject
  REPOSITORY_INTEGRITY
  Hide repository_integrity attributes Show repository_integrity attributes object
  statusstring Required
  Values are green, yellow, red, or unknown.
  symptomstring Required
  impactsarray[object]
  Hide impacts attributes Show impacts attributes object
  descriptionstring Required
  idstring Required
  impact_areasarray[string] Required
  Values are search, ingest, backup, or deployment_management.
  severitynumber Required
  diagnosisarray[object]
  Hide diagnosis attributes Show diagnosis attributes object
  idstring Required
  actionstring Required
  affected_resourcesobject Required
  causestring Required
  help_urlstring Required
  detailsobject
  Hide details attributes Show details attributes object
  total_repositoriesnumber
  corrupted_repositoriesnumber
  corruptedarray[string]
  data_stream_lifecycleobject
  DATA_STREAM_LIFECYCLE
  Hide data_stream_lifecycle attributes Show data_stream_lifecycle attributes object
  statusstring Required
  Values are green, yellow, red, or unknown.
  symptomstring Required
  impactsarray[object]
  Hide impacts attributes Show impacts attributes object
  descriptionstring Required
  idstring Required
  impact_areasarray[string] Required
  Values are search, ingest, backup, or deployment_management.
  severitynumber Required
  diagnosisarray[object]
  Hide diagnosis attributes Show diagnosis attributes object
  idstring Required
  actionstring Required
  affected_resourcesobject Required
  causestring Required
  help_urlstring Required
  detailsobject
  Hide details attributes Show details attributes object
  stagnating_backing_indices_countnumber Required
  total_backing_indices_in_errornumber Required
  stagnating_backing_indicesarray[object]
  ilmobject
  ILM
  Hide ilm attributes Show ilm attributes object
  statusstring Required
  Values are green, yellow, red, or unknown.
  symptomstring Required
  impactsarray[object]
  Hide impacts attributes Show impacts attributes object
  descriptionstring Required
  idstring Required
  impact_areasarray[string] Required
  Values are search, ingest, backup, or deployment_management.
  severitynumber Required
  diagnosisarray[object]
  Hide diagnosis attributes Show diagnosis attributes object
  idstring Required
  actionstring Required
  affected_resourcesobject Required
  causestring Required
  help_urlstring Required
  detailsobject
  Hide details attributes Show details attributes object
  ilm_statusstring Required
  Values are RUNNING, STOPPING, or STOPPED.
  policiesnumber Required
  stagnating_indicesnumber Required
  slmobject
  SLM
  Hide slm attributes Show slm attributes object
  statusstring Required
  Values are green, yellow, red, or unknown.
  symptomstring Required
  impactsarray[object]
  Hide impacts attributes Show impacts attributes object
  descriptionstring Required
  idstring Required
  impact_areasarray[string] Required
  Values are search, ingest, backup, or deployment_management.
  severitynumber Required
  diagnosisarray[object]
  Hide diagnosis attributes Show diagnosis attributes object
  idstring Required
  actionstring Required
  affected_resourcesobject Required
  causestring Required
  help_urlstring Required
  detailsobject
  Hide details attributes Show details attributes object
  slm_statusstring Required
  Values are RUNNING, STOPPING, or STOPPED.
  policiesnumber Required
  unhealthy_policiesobject
  Hide unhealthy_policies attributes Show unhealthy_policies attributes object
  countnumber Required
  invocations_since_last_successobject
  shards_capacityobject
  SHARDS_CAPACITY
  Hide shards_capacity attributes Show shards_capacity attributes object
  statusstring Required
  Values are green, yellow, red, or unknown.
  symptomstring Required
  impactsarray[object]
  Hide impacts attributes Show impacts attributes object
  descriptionstring Required
  idstring Required
  impact_areasarray[string] Required
  Values are search, ingest, backup, or deployment_management.
  severitynumber Required
  diagnosisarray[object]
  Hide diagnosis attributes Show diagnosis attributes object
  idstring Required
  actionstring Required
  affected_resourcesobject Required
  causestring Required
  help_urlstring Required
  detailsobject
  Hide details attributes Show details attributes object
  dataobject Required
  Hide data attributes Show data attributes object
  max_shards_in_clusternumber Required
  current_used_shardsnumber
  frozenobject Required
  Hide frozen attributes Show frozen attributes object
  max_shards_in_clusternumber Required
  current_used_shardsnumber
  file_settingsobject
  FILE_SETTINGS
  Hide file_settings attributes Show file_settings attributes object
  statusstring Required
  Values are green, yellow, red, or unknown.
  symptomstring Required
  impactsarray[object]
  Hide impacts attributes Show impacts attributes object
  descriptionstring Required
  idstring Required
  impact_areasarray[string] Required
  Values are search, ingest, backup, or deployment_management.
  severitynumber Required
  diagnosisarray[object]
  Hide diagnosis attributes Show diagnosis attributes object
  idstring Required
  actionstring Required
  affected_resourcesobject Required
  causestring Required
  help_urlstring Required
  detailsobject
  Hide details attributes Show details attributes object
  failure_streaknumber Required
  most_recent_failurestring Required
- statusstring
  Values are green, yellow, red, or unknown.

GET /_health_report

GET _health_report

resp = client.health_report()

const response = await client.healthReport();

response = client.health_report

$resp = $client->healthReport();

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_health_report"