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.

      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.

    • 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

        The node’s host name.

      • http object
      • index_version number
      • ip string

        The node’s IP address.

      • jvm object
      • name string

        The node's name

      • os object
      • plugins array[object]
      • process object
      • roles array[string]

        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
      • 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
      • transport object
      • transport_address string

        Host and port where transport HTTP connections are accepted.

      • transport_version number
      • version string

        Elasticsearch version running on this node.

      • modules array[object]
      • ingest object
      • aggregations object
        Hide aggregations attribute Show aggregations attribute object

        • * object Additional properties
      • remote_cluster_server object