Get node attribute information

GET /_cat/nodeattrs

Get information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Required authorization

Cluster privileges: monitor

Query Parameters

Response

application/json

Examples

A successful response from GET /_cat/nodeattrs?v=true&format=json. The node, host, and ip columns provide basic information about each node. The attr and value columns return custom node attributes, one per line.

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET /_cat/nodeattrs?v=true&format=json

JavaScript Elasticsearch JavaScript Client

const response = await client.cat.nodeattrs({
  v: "true",
  format: "json",
});

Python Elasticsearch Python Client

resp = client.cat.nodeattrs(
    v=True,
    format="json",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_cat/nodeattrs?v=true&format=json" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.cat().nodeattrs();

PHP Elasticsearch PHP Client

$resp = $client->cat()->nodeattrs([
    "v" => "true",
    "format" => "json",
]);

Ruby Elasticsearch Ruby Client

response = client.cat.nodeattrs(
  v: "true",
  format: "json"
)

Response

[
  {
    "node": "node-0",
    "host": "127.0.0.1",
    "ip": "127.0.0.1",
    "attr": "testattr",
    "value": "test"
  }
]

Required authorization

Query Parameters { h , s , local , master_timeout , }

Response

Query Parameters