Get feature usage information

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

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

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

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _nodes/usage

JavaScript Elasticsearch JavaScript Client

const response = await client.nodes.usage();

Python Elasticsearch Python Client

resp = client.nodes.usage()

curl Shell

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

Java Elasticsearch Java Client

client.nodes().usage(u -> u);

C# Elasticsearch .NET Client

var response = await client.Nodes.UsageAsync();

PHP Elasticsearch PHP Client

$resp = $client->nodes()->usage();

Ruby Elasticsearch Ruby Client

response = client.nodes.usage

Response

No example