Get node information

GET /_nodes/{node_id}/{metric}
GET /_nodes/{node_id}
GET /_nodes/{metric}
GET /_nodes

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 union oneOf · default: 30s: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.; Values: -1 0

Response

application/json

_nodes object: Contains statistics about the number of nodes selected by the request’s node filters.
cluster_name string required
nodes map string to object required

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _nodes/_all/jvm

JavaScript Elasticsearch JavaScript Client

const response = await client.nodes.info({
  node_id: "_all",
  metric: "jvm",
});

Python Elasticsearch Python Client

resp = client.nodes.info(
    node_id="_all",
    metric="jvm",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_nodes/_all/jvm" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.nodes().info(i -> i
    .metric("jvm")
    .nodeId("_all")
);

C# Elasticsearch .NET Client

var response = await client.Nodes
    .InfoAsync(d1 => d1
        .Metric("jvm")
        .NodeId("_all")
    );

PHP Elasticsearch PHP Client

$resp = $client->nodes()->info([
    "node_id" => "_all",
    "metric" => "jvm",
]);

Ruby Elasticsearch Ruby Client

response = client.nodes.info(
  node_id: "_all",
  metric: "jvm"
)

Response

An abbreviated response when requesting cluster nodes information.

{
    "_nodes": {},
    "cluster_name": "elasticsearch",
    "nodes": {
      "USpTGYaBSIKbgSUJR2Z9lg": {
        "name": "node-0",
        "transport_address": "192.168.17:9300",
        "host": "node-0.elastic.co",
        "ip": "192.168.17",
        "version": "{version}",
        "transport_version": 100000298,
        "index_version": 100000074,
        "component_versions": {
          "ml_config_version": 100000162,
          "transform_config_version": 100000096
        },
        "build_flavor": "default",
        "build_type": "{build_type}",
        "build_hash": "587409e",
        "roles": [
          "master",
          "data",
          "ingest"
        ],
        "attributes": {},
        "plugins": [
          {
            "name": "analysis-icu",
            "version": "{version}",
            "description": "The ICU Analysis plugin integrates Lucene ICU
  module into elasticsearch, adding ICU relates analysis components.",
            "classname":
  "org.elasticsearch.plugin.analysis.icu.AnalysisICUPlugin",
            "has_native_controller": false
          }
        ],
        "modules": [
          {
            "name": "lang-painless",
            "version": "{version}",
            "description": "An easy, safe and fast scripting language for
  Elasticsearch",
            "classname": "org.elasticsearch.painless.PainlessPlugin",
            "has_native_controller": false
          }
        ]
      }
    }
}