Path parameters

• feature string | array[string] Required

  A feature of the cluster, as returned by the top-level health report API.

Query parameters

• timeout string

  Explicit operation timeout.

• verbose boolean

  Opt-in for more information about the health of the system.

• size number

  Limit the number of affected resources the health report API returns.

Responses

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

  • cluster_name string Required
  • indicators object Required

    Additional properties are allowed.

    Hide indicators attributes Show indicators attributes object

    • master_is_stable object

      Additional properties are allowed.

      Hide master_is_stable attributes Show master_is_stable attributes object

      • status string Required

        Values are green, yellow, red, or unknown.

      • symptom string Required
      • impacts array[object]
        Hide impacts attributes Show impacts attributes object

        • description string Required
        • id string Required
        • impact_areas array[string] Required

          Values are search, ingest, backup, or deployment_management.

        • severity number Required
      • diagnosis array[object]
        Hide diagnosis attributes Show diagnosis attributes object

        • id string Required
        • action string Required
        • affected_resources object Required

          Additional properties are allowed.

        • cause string Required
        • help_url string Required
      • details object

        Additional properties are allowed.

        Hide details attributes Show details attributes object

        • current_master object Required

          Additional properties are allowed.

          Hide current_master attributes Show current_master attributes object

          • name
          • node_id
        • recent_masters array[object] Required

          Additional properties are allowed.

        • exception_fetching_history object

          Additional properties are allowed.

          Hide exception_fetching_history attributes Show exception_fetching_history attributes object

          • message string Required
          • stack_trace string Required
        • cluster_formation array[object]

          Additional properties are allowed.

    • shards_availability object

      Additional properties are allowed.

      Hide shards_availability attributes Show shards_availability attributes object

      • status string Required

        Values are green, yellow, red, or unknown.

      • symptom string Required
      • impacts array[object]
        Hide impacts attributes Show impacts attributes object

        • description string Required
        • id string Required
        • impact_areas array[string] Required

          Values are search, ingest, backup, or deployment_management.

        • severity number Required
      • diagnosis array[object]
        Hide diagnosis attributes Show diagnosis attributes object

        • id string Required
        • action string Required
        • affected_resources object Required

          Additional properties are allowed.

        • cause string Required
        • help_url string Required
      • details object

        Additional properties are allowed.

        Hide details attributes Show details attributes object

        • creating_primaries number Required
        • creating_replicas number Required
        • initializing_primaries number Required
        • initializing_replicas number Required
        • restarting_primaries number Required
        • restarting_replicas number Required
        • started_primaries number Required
        • started_replicas number Required
        • unassigned_primaries number Required
        • unassigned_replicas number Required
    • disk object

      Additional properties are allowed.

      Hide disk attributes Show disk attributes object

      • status string Required

        Values are green, yellow, red, or unknown.

      • symptom string Required
      • impacts array[object]
        Hide impacts attributes Show impacts attributes object

        • description string Required
        • id string Required
        • impact_areas array[string] Required

          Values are search, ingest, backup, or deployment_management.

        • severity number Required
      • diagnosis array[object]
        Hide diagnosis attributes Show diagnosis attributes object

        • id string Required
        • action string Required
        • affected_resources object Required

          Additional properties are allowed.

        • cause string Required
        • help_url string Required
      • details object

        Additional properties are allowed.

        Hide details attributes Show details attributes object

        • indices_with_readonly_block number Required
        • nodes_with_enough_disk_space number Required
        • nodes_over_high_watermark number Required
        • nodes_over_flood_stage_watermark number Required
        • nodes_with_unknown_disk_status number Required
    • repository_integrity object

      Additional properties are allowed.

      Hide repository_integrity attributes Show repository_integrity attributes object

      • status string Required

        Values are green, yellow, red, or unknown.

      • symptom string Required
      • impacts array[object]
        Hide impacts attributes Show impacts attributes object

        • description string Required
        • id string Required
        • impact_areas array[string] Required

          Values are search, ingest, backup, or deployment_management.

        • severity number Required
      • diagnosis array[object]
        Hide diagnosis attributes Show diagnosis attributes object

        • id string Required
        • action string Required
        • affected_resources object Required

          Additional properties are allowed.

        • cause string Required
        • help_url string Required
      • details object

        Additional properties are allowed.

        Hide details attributes Show details attributes object

        • total_repositories number
        • corrupted_repositories number
        • corrupted array[string]
    • data_stream_lifecycle object

      Additional properties are allowed.

      Hide data_stream_lifecycle attributes Show data_stream_lifecycle attributes object

      • status string Required

        Values are green, yellow, red, or unknown.

      • symptom string Required
      • impacts array[object]
        Hide impacts attributes Show impacts attributes object

        • description string Required
        • id string Required
        • impact_areas array[string] Required

          Values are search, ingest, backup, or deployment_management.

        • severity number Required
      • diagnosis array[object]
        Hide diagnosis attributes Show diagnosis attributes object

        • id string Required
        • action string Required
        • affected_resources object Required

          Additional properties are allowed.

        • cause string Required
        • help_url string Required
      • details object

        Additional properties are allowed.

        Hide details attributes Show details attributes object

        • stagnating_backing_indices_count number Required
        • total_backing_indices_in_error number Required
        • stagnating_backing_indices array[object]

          Additional properties are allowed.

    • ilm object

      Additional properties are allowed.

      Hide ilm attributes Show ilm attributes object

      • status string Required

        Values are green, yellow, red, or unknown.

      • symptom string Required
      • impacts array[object]
        Hide impacts attributes Show impacts attributes object

        • description string Required
        • id string Required
        • impact_areas array[string] Required

          Values are search, ingest, backup, or deployment_management.

        • severity number Required
      • diagnosis array[object]
        Hide diagnosis attributes Show diagnosis attributes object

        • id string Required
        • action string Required
        • affected_resources object Required

          Additional properties are allowed.

        • cause string Required
        • help_url string Required
      • details object

        Additional properties are allowed.

        Hide details attributes Show details attributes object

        • ilm_status string Required

          Values are RUNNING, STOPPING, or STOPPED.

        • policies number Required
        • stagnating_indices number Required
    • slm object

      Additional properties are allowed.

      Hide slm attributes Show slm attributes object

      • status string Required

        Values are green, yellow, red, or unknown.

      • symptom string Required
      • impacts array[object]
        Hide impacts attributes Show impacts attributes object

        • description string Required
        • id string Required
        • impact_areas array[string] Required

          Values are search, ingest, backup, or deployment_management.

        • severity number Required
      • diagnosis array[object]
        Hide diagnosis attributes Show diagnosis attributes object

        • id string Required
        • action string Required
        • affected_resources object Required

          Additional properties are allowed.

        • cause string Required
        • help_url string Required
      • details object

        Additional properties are allowed.

        Hide details attributes Show details attributes object

        • slm_status string Required

          Values are RUNNING, STOPPING, or STOPPED.

        • policies number Required
        • unhealthy_policies object

          Additional properties are allowed.

          Hide unhealthy_policies attributes Show unhealthy_policies attributes object

          • count number Required
          • invocations_since_last_success object
    • shards_capacity object

      Additional properties are allowed.

      Hide shards_capacity attributes Show shards_capacity attributes object

      • status string Required

        Values are green, yellow, red, or unknown.

      • symptom string Required
      • impacts array[object]
        Hide impacts attributes Show impacts attributes object

        • description string Required
        • id string Required
        • impact_areas array[string] Required

          Values are search, ingest, backup, or deployment_management.

        • severity number Required
      • diagnosis array[object]
        Hide diagnosis attributes Show diagnosis attributes object

        • id string Required
        • action string Required
        • affected_resources object Required

          Additional properties are allowed.

        • cause string Required
        • help_url string Required
      • details object

        Additional properties are allowed.

        Hide details attributes Show details attributes object

        • data object Required

          Additional properties are allowed.

          Hide data attributes Show data attributes object

          • max_shards_in_cluster number Required
          • current_used_shards number
        • frozen object Required

          Additional properties are allowed.

          Hide frozen attributes Show frozen attributes object

          • max_shards_in_cluster number Required
          • current_used_shards number
  • status string

    Values are green, yellow, red, or unknown.