Get feature usage information | Elasticsearch API documentation (v9)

Path parameters

metricstring | array[string] Required
Limits the information returned to the specific metrics. A comma-separated list of the following options: _all, rest_actions.

Query parameters

timeoutstring
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
- _nodesobject
  Hide _nodes attributes Show _nodes attributes object
  failuresarray[object]
  Hide failures attributes Show failures attributes object
  typestring Required
  The type of error
  reasonstring | null
  A human-readable explanation of the error, in English.
  One of:
  string-1string string-2string | null
  stack_tracestring
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  caused_byobject
  root_causearray[object]
  suppressedarray[object]
  totalnumber Required
  Total number of nodes selected by the request.
  successfulnumber Required
  Number of nodes that responded successfully to the request.
  failednumber 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_namestring Required
- nodesobject Required
  Hide nodes attribute Show nodes attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  rest_actionsobject Required
  Hide rest_actions attribute Show rest_actions attribute object
  *number Additional properties
  Time unit for milliseconds
  Time unit for milliseconds
  aggregationsobject Required
  Hide aggregations attribute Show aggregations attribute object
  *object Additional properties

GET /_nodes/usage/{metric}

curl \
 --request GET 'http://api.example.com/_nodes/usage/{metric}' \
 --header "Authorization: $API_KEY"