Path parameters

• node_id string | array[string] Required

  Comma-separated list of node IDs or names used to limit returned information.

• 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.

  External documentation

Responses

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

  • _nodes object

    Contains statistics about the number of nodes selected by the request’s node filters.

    Hide _nodes attributes Show _nodes attributes object

    • failures array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Hide failures attributes Show failures attributes object

      • type string Required

        The type of error

      • reason
      • stack_trace string

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

      • caused_by
      • 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
      • component_versions object Required
        Hide component_versions attribute Show component_versions attribute object

        • * number Additional properties
      • host string Required

        The node’s host name.

      • http object
        Hide http attributes Show http attributes object

        • bound_address array[string] Required
        • max_content_length_in_bytes number Required
        • publish_address string Required
      • index_version number Required
      • ip string Required

        The node’s IP address.

      • jvm object
        Hide jvm attributes Show jvm attributes object

        • gc_collectors array[string] Required
        • memory_pools array[string] Required
        • pid number Required
        • vm_vendor string Required
        • using_bundled_jdk boolean Required
        • using_compressed_ordinary_object_pointers
        • input_arguments array[string] Required
      • name string Required

        The node's name

      • 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.

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

        • classname string Required
        • description string Required
        • elasticsearch_version
        • extended_plugins array[string] Required
        • has_native_controller boolean Required
        • java_version
        • name
        • version
        • 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

      • roles array[string] Required

        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
      • thread_pool object
        Hide thread_pool attribute Show thread_pool attribute object

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

          • core number
          • 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

        Same as total_indexing_buffer, but expressed in bytes.

        One of:

        number-1 number string-2 string

        Same as total_indexing_buffer, but expressed in bytes.

        Same as total_indexing_buffer, but expressed in bytes.

      • transport object
        Hide transport attributes Show transport attributes object

        • bound_address array[string] Required
        • publish_address string Required
        • profiles object Required
      • transport_address string Required

        Host and port where transport HTTP connections are accepted.

      • transport_version number Required
      • version string Required

        Elasticsearch version running on this node.

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

        • classname string Required
        • description string Required
        • elasticsearch_version
        • extended_plugins array[string] Required
        • has_native_controller boolean Required
        • java_version
        • name
        • version
        • 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
      • remote_cluster_server object
        Hide remote_cluster_server attribute Show remote_cluster_server attribute object

        • bound_address array[string] Required