Get node information

Auth

By default, the API returns all attributes and core settings for cluster nodes.

Path parameters

node_id union string | string[] optional

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

Leave it out to use /_nodes.

metric union string | string[] optional

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

Leave it out to use /_nodes.

Query parameters

flat_settings boolean · default: false

If true, returns settings in flat format.

timeout string · default: 30s

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

Response

application/json
_nodes object

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

failures object[]
type string required

The type of error

reason union string nullable

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

One of: string
stack_trace string

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

caused_by object
Same fields as failures in _nodes
root_cause object[]
Same fields as failures in _nodes
suppressed object[]
Same fields as failures in _nodes
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 map string to object required
<string> object
attributes map string to string required
build_flavor string required
build_hash string required

Short hash of the last git commit in this release.

build_type string required
component_versions map string to number required
host string required

The node’s host name.

http object
bound_address string[] required
max_content_length number | string
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
gc_collectors string[] required
mem object required
direct_max number | string
direct_max_in_bytes number required
heap_init number | string
heap_init_in_bytes number required
heap_max number | string
heap_max_in_bytes number required
non_heap_init number | string
non_heap_init_in_bytes number required
non_heap_max number | string
non_heap_max_in_bytes number required
memory_pools string[] required
pid number required
start_time_in_millis number required
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
input_arguments string[] required
name string required

The node's name

os 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

Name of the operating system (ex: Linux, Windows, Mac OS X)

pretty_name string required
refresh_interval_in_millis number required

Refresh interval for the OS statistics

version string required

Version of the operating system

cpu 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
total string required
total_in_bytes number required
swap object
total string required
total_in_bytes number required
plugins object[]
classname string required
description string required
elasticsearch_version string required
extended_plugins string[] required
has_native_controller boolean required
java_version string required
name string required
version string required
licensed boolean required
process object
id number required

Process identifier (PID)

mlockall boolean required

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

refresh_interval_in_millis number required

Refresh interval for the process statistics

roles enum[] required
Values: master data data_cold data_content data_frozen data_hot data_warm client ingest ml voting_only transform remote_cluster_client coordinating_only
settings object
cluster object required
name string required
routing object
allocation object
enable enum
Values: all primaries new_primaries none
include object
_tier_preference string
_id string
require object

Assign the index to a node whose attribute has all of the given values. Each key is a node attribute: one of the built-in attributes _name, _host_ip, _publish_ip, _ip, _host, _id and _tier, or a custom node attribute. Each value is a comma-separated string or an array of strings, and can use wildcards.

initial_recovery object
_id string
disk object
threshold_enabled boolean | string
rebalance object
enable enum required
Values: all primaries replicas none
election object required
strategy string required
initial_master_nodes union string[] | string
deprecation_indexing object
enabled boolean | string required
node object required
name string required
attr map string to object required
max_local_storage_nodes string
path object
logs string
home string
repo string[]
data union string | string[]
repositories object
url object required
allowed_urls string required
discovery object
seed_hosts union string[] | string
type string
seed_providers union string[] | string
action object
destructive_requires_name string required
client object
type string required
http object required
type object required
default string required
type.default string
compression boolean | string
port number | string
bootstrap object
memory_lock string required
transport object required
type object required
default string required
type.default string
features object
x-pack string required
network object
host union string | string[]
xpack object
license object
self_generated object required
type string required
security object required
http object
ssl map string to string required
enabled string required
transport object
ssl map string to string required
authc object
realms object
file map string to object
<string> object
enabled string
order string required
native map string to object
<string> object
enabled string
order string required
pki map string to object
<string> object
enabled string
order string required
token object
enabled string required
notification map string to object
ml object
use_auto_machine_memory_percent boolean
script object
allowed_types string required
disable_max_compilations_rate string
remote object required
connect string required
ingest object
attachment object
downloader object required
enabled string required
append object
downloader object required
enabled string required
csv object
downloader object required
enabled string required
convert object
downloader object required
enabled string required
date object
downloader object required
enabled string required
date_index_name object
downloader object required
enabled string required
dot_expander object
downloader object required
enabled string required
enrich object
downloader object required
enabled string required
fail object
downloader object required
enabled string required
foreach object
downloader object required
enabled string required
json object
downloader object required
enabled string required
user_agent object
downloader object required
enabled string required
kv object
downloader object required
enabled string required
geoip object
downloader object required
enabled string required
grok object
downloader object required
enabled string required
gsub object
downloader object required
enabled string required
join object
downloader object required
enabled string required
lowercase object
downloader object required
enabled string required
remove object
downloader object required
enabled string required
rename object
downloader object required
enabled string required
script object
downloader object required
enabled string required
set object
downloader object required
enabled string required
sort object
downloader object required
enabled string required
split object
downloader object required
enabled string required
trim object
downloader object required
enabled string required
uppercase object
downloader object required
enabled string required
urldecode object
downloader object required
enabled string required
bytes object
downloader object required
enabled string required
dissect object
downloader object required
enabled string required
set_security_user object
downloader object required
enabled string required
pipeline object
downloader object required
enabled string required
drop object
downloader object required
enabled string required
circle object
downloader object required
enabled string required
inference object
downloader object required
enabled string required
thread_pool map string to object
<string> object
core number
keep_alive string
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.

transport object
bound_address string[] required
publish_address string required
profiles map string to string 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 object[]
classname string required
description string required
elasticsearch_version string required
extended_plugins string[] required
has_native_controller boolean required
java_version string required
name string required
version string required
licensed boolean required
ingest object
processors object[] required
type string required
aggregations map string to object
<string> object
types string[] required
remote_cluster_server object
bound_address string[] required
publish_address string required