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.

  Values are -1 or 0.

Responses

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

  • _nodes object

    Contains statistics about the number of nodes selected by the request.

    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 string | null

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

        One of:

        string-1 string string-2 string | null
      • stack_trace string

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

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

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

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

        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