Path parameters

• index string | array[string] Required

  Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.

Query parameters

• expand_wildcards string | array[string]

  Whether to expand wildcard expression to concrete indices that are open, closed or both.

• level string

  Can be one of cluster, indices or shards. Controls the details level of the health information returned.

  Values are cluster, indices, or shards.

• local boolean

  If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

• master_timeout string

  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.

• timeout string

  Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

• wait_for_active_shards number | string

  A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.

• wait_for_events string

  Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.

  Values are immediate, urgent, high, normal, low, or languid.

• wait_for_nodes string | number

  The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation.

• wait_for_no_initializing_shards boolean

  A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards.

• wait_for_no_relocating_shards boolean

  A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards.

• wait_for_status string

  One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status.

  Values are green, GREEN, yellow, YELLOW, red, or RED.

Responses

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

  • active_primary_shards number Required

    The number of active primary shards.

  • active_shards number Required

    The total number of active primary and replica shards.

  • active_shards_percent string

    The ratio of active shards in the cluster expressed as a string formatted percentage.

  • active_shards_percent_as_number number Required

    The ratio of active shards in the cluster expressed as a percentage.

  • cluster_name string Required
  • delayed_unassigned_shards number Required

    The number of shards whose allocation has been delayed by the timeout settings.

  • indices object
    Hide indices attribute Show indices attribute object

    • * object Additional properties
      Hide * attributes Show * attributes object

      • active_primary_shards number Required
      • active_shards number Required
      • initializing_shards number Required
      • number_of_replicas number Required
      • number_of_shards number Required
      • relocating_shards number Required
      • shards object
        Hide shards attribute Show shards attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • active_shards number Required
          • initializing_shards number Required
          • primary_active boolean Required
          • relocating_shards number Required
          • status string Required

            Values are green, GREEN, yellow, YELLOW, red, or RED.

          • unassigned_shards number Required
          • unassigned_primary_shards number Required
      • status string Required

        Values are green, GREEN, yellow, YELLOW, red, or RED.

      • unassigned_shards number Required
      • unassigned_primary_shards number Required
  • initializing_shards number Required

    The number of shards that are under initialization.

  • number_of_data_nodes number Required

    The number of nodes that are dedicated data nodes.

  • number_of_in_flight_fetch number Required

    The number of unfinished fetches.

  • number_of_nodes number Required

    The number of nodes within the cluster.

  • number_of_pending_tasks number Required

    The number of cluster-level changes that have not yet been executed.

  • relocating_shards number Required

    The number of shards that are under relocation.

  • status string Required

    Values are green, GREEN, yellow, YELLOW, red, or RED.

  • task_max_waiting_in_queue string

    A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • task_max_waiting_in_queue_millis number

    Time unit for milliseconds

  • timed_out boolean Required

    If false the response returned within the period of time that is specified by the timeout parameter (30s by default)

  • unassigned_primary_shards number Required

    The number of primary shards that are not allocated.

  • unassigned_shards number Required

    The number of shards that are not allocated.

Query parameters

• dry_run boolean

  If true, then the request simulates the operation. It will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes.

• explain boolean

  If true, then the response contains an explanation of why the commands can or cannot run.

• metric string | array[string]

  Limits the information returned to the specified metrics.

• retry_failed boolean

  If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.

• master_timeout string

  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.

• timeout string

  Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Responses

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

  • acknowledged boolean Required
  • explanations array[object]
    Hide explanations attributes Show explanations attributes object

    • command string Required
    • decisions array[object] Required
      Hide decisions attributes Show decisions attributes object

      • decider string Required
      • decision string Required
      • explanation string Required
    • parameters object Required
      Hide parameters attributes Show parameters attributes object

      • allow_primary boolean Required
      • index string Required
      • node string Required
      • shard number Required
      • from_node string
      • to_node string
  • state object

    There aren't any guarantees on the output/structure of the raw cluster state. Here you will find the internal representation of the cluster, which can differ from the external representation.

Path parameters

• metric string | array[string] Required

  Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.

Query parameters

• flat_settings boolean

  If true, returns settings in flat format.

• timeout string

  Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Responses

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

  • _nodes object
    Hide _nodes attributes Show _nodes attributes object

    • failures array[object]
      Hide failures attributes Show failures attributes object

      • type string Required

        The type of error

      • reason string

        A human-readable explanation of the error, in English.

      • stack_trace string

        The server stack trace. Present only if the error_trace=true parameter was sent with the request.

      • caused_by object
      • root_cause array[object]
      • suppressed array[object]
    • total number Required

      Total number of nodes selected by the request.

    • successful number Required

      Number of nodes that responded successfully to the request.

    • failed number Required

      Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.

  • cluster_name string Required
  • nodes object Required
    Hide nodes attribute Show nodes attribute object

    • * object Additional properties
      Hide * attributes Show * attributes object

      • attributes object Required
        Hide attributes attribute Show attributes attribute object

        • * string Additional properties
      • build_flavor string Required
      • build_hash string Required

        Short hash of the last git commit in this release.

      • build_type string Required
      • host string Required
      • http object
        Hide http attributes Show http attributes object

        • bound_address array[string] Required

        • max_content_length number | string

          One of:

          ByteSize number ByteSize string
        • max_content_length_in_bytes number Required
        • publish_address string Required
      • ip string Required
      • jvm object
        Hide jvm attributes Show jvm attributes object

        • gc_collectors array[string] Required
        • mem object Required
          Hide mem attributes Show mem attributes object

          • direct_max
          • direct_max_in_bytes number Required
          • heap_init
          • heap_init_in_bytes number Required
          • heap_max
          • heap_max_in_bytes number Required
          • non_heap_init
          • non_heap_init_in_bytes number Required
          • non_heap_max
          • non_heap_max_in_bytes number Required
        • memory_pools array[string] Required
        • pid number Required

        • Time unit for milliseconds

        • version string Required
        • vm_name string Required
        • vm_vendor string Required
        • vm_version string Required
        • using_bundled_jdk boolean Required

        • using_compressed_ordinary_object_pointers boolean | string

          One of:

          boolean-1 boolean string-2 string
        • input_arguments array[string] Required
      • name string Required
      • network object
        Hide network attributes Show network attributes object

        • primary_interface object Required
          Hide primary_interface attributes Show primary_interface attributes object

          • address string Required
          • mac_address string Required
          • name string Required
        • refresh_interval number Required
      • os object
        Hide os attributes Show os attributes object

        • arch string Required

          Name of the JVM architecture (ex: amd64, x86)

        • available_processors number Required

          Number of processors available to the Java virtual machine

        • allocated_processors number

          The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS.

        • name string Required
        • pretty_name string Required

        • Time unit for milliseconds

        • version string Required
        • cpu object
          Hide cpu attributes Show cpu attributes object

          • cache_size string Required
          • cache_size_in_bytes number Required
          • cores_per_socket number Required
          • mhz number Required
          • model string Required
          • total_cores number Required
          • total_sockets number Required
          • vendor string Required
        • mem object
          Hide mem attributes Show mem attributes object

          • total string Required
          • total_in_bytes number Required
        • swap object
          Hide swap attributes Show swap attributes object

          • total string Required
          • total_in_bytes number Required
      • plugins array[object]
        Hide plugins attributes Show plugins attributes object

        • classname string Required
        • description string Required
        • elasticsearch_version string Required
        • extended_plugins array[string] Required
        • has_native_controller boolean Required
        • java_version string Required
        • name string Required
        • version string Required
        • licensed boolean Required
      • process object
        Hide process attributes Show process attributes object

        • id number Required

          Process identifier (PID)

        • mlockall boolean Required

          Indicates if the process address space has been successfully locked in memory

        • Time unit for milliseconds

      • roles array[string] Required
        • @doc_id node-roles

        Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.

      • settings object
        Hide settings attributes Show settings attributes object

        • cluster object Required
          Hide cluster attributes Show cluster attributes object

          • name string Required
          • routing object
          • election object Required
          • initial_master_nodes array[string]
          • deprecation_indexing object
        • node object Required
          Hide node attributes Show node attributes object

          • name string Required
          • attr object Required
          • max_local_storage_nodes string
        • path object
          Hide path attributes Show path attributes object

          • logs string
          • home string
          • repo array[string]
          • data
        • repositories object
          Hide repositories attribute Show repositories attribute object

          • url object Required
        • discovery object
          Hide discovery attributes Show discovery attributes object

          • seed_hosts array[string]
          • type string
          • seed_providers array[string]
        • action object
          Hide action attribute Show action attribute object

          • destructive_requires_name string Required
        • client object
          Hide client attribute Show client attribute object

          • type string Required
        • http object Required
          Hide http attributes Show http attributes object

          • type object Required
          • type.default string
          • compression
          • port
        • bootstrap object
          Hide bootstrap attribute Show bootstrap attribute object

          • memory_lock string Required
        • transport object Required
          Hide transport attributes Show transport attributes object

          • type object Required
          • type.default string
          • features object
        • network object
          Hide network attribute Show network attribute object

          • host
        • xpack object
          Hide xpack attributes Show xpack attributes object

          • license object
          • security object Required
          • notification object
          • ml object
        • script object
          Hide script attributes Show script attributes object

          • allowed_types string Required
          • disable_max_compilations_rate string
        • search object
          Hide search attribute Show search attribute object

          • remote object Required
        • ingest object
          Hide ingest attributes Show ingest attributes object

          • attachment object
          • append object
          • csv object
          • convert object
          • date object
          • date_index_name object
          • dot_expander object
          • enrich object
          • fail object
          • foreach object
          • json object
          • user_agent object
          • kv object
          • geoip object
          • grok object
          • gsub object
          • join object
          • lowercase object
          • remove object
          • rename object
          • script object
          • set object
          • sort object
          • split object
          • trim object
          • uppercase object
          • urldecode object
          • bytes object
          • dissect object
          • set_security_user object
          • pipeline object
          • drop object
          • circle object
          • inference object
      • thread_pool object
        Hide thread_pool attribute Show thread_pool attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • core number
          • keep_alive string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • max number
          • queue_size number Required
          • size number
          • type string Required
      • total_indexing_buffer number

        Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings.

      • total_indexing_buffer_in_bytes number | string

        One of:

        ByteSize number ByteSize string
      • transport object
        Hide transport attributes Show transport attributes object

        • bound_address array[string] Required
        • publish_address string Required
        • profiles object Required
          Hide profiles attribute Show profiles attribute object

          • * string Additional properties
      • transport_address string Required
      • version string Required
      • modules array[object]
        Hide modules attributes Show modules attributes object

        • classname string Required
        • description string Required
        • elasticsearch_version string Required
        • extended_plugins array[string] Required
        • has_native_controller boolean Required
        • java_version string Required
        • name string Required
        • version string Required
        • licensed boolean Required
      • ingest object
        Hide ingest attribute Show ingest attribute object

        • processors array[object] Required
      • aggregations object
        Hide aggregations attribute Show aggregations attribute object

        • * object Additional properties
          Hide * attribute Show * attribute object

          • types array[string] Required