Get node statistics

Create or update an autoscaling policy Added in 7.11.0

PUT /_autoscaling/policy/{name}

NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

External documentation

Path parameters

name string Required

the name of the autoscaling policy

Query parameters

master_timeout string

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

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

application/json

Body Required

roles array[string] Required
deciders object Required

Decider settings.

External documentation
Hide deciders attribute Show deciders attribute object
- * object Additional properties

Responses

200 application/json
Hide response attribute Show response attribute object
- acknowledged boolean Required
  
  For a successful response, this value is always true. On failure, an exception is returned instead.

PUT /_autoscaling/policy/{name}

curl \
 --request PUT 'http://api.example.com/_autoscaling/policy/{name}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"roles\": [],\n  \"deciders\": {\n    \"fixed\": {\n    }\n  }\n}"'

Request examples

{
  "roles": [],
  "deciders": {
    "fixed": {
    }
  }
}

The API method and path for this request: `PUT /_autoscaling/policy/my_autoscaling_policy`. It creates `my_autoscaling_policy` using the fixed autoscaling decider, applying to the set of nodes having (only) the `data_hot` role.

{
  "roles" : [ "data_hot" ],
  "deciders": {
    "fixed": {
    }
  }
}

Response examples (200)

{
  "acknowledged": true
}

Get the autoscaling capacity Added in 7.11.0

GET /_autoscaling/capacity

Api key auth Basic auth Bearer auth

NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

This API gets the current autoscaling capacity based on the configured autoscaling policy. It will return information to size the cluster appropriately to the current workload.

The required_capacity is calculated as the maximum of the required_capacity result of all individual deciders that are enabled for the policy.

The operator should verify that the current_nodes match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information.

The response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required. This information is provided for diagnosis only. Do not use this information to make autoscaling decisions.

External documentation

Query parameters

master_timeout string

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

Responses

200 application/json
Hide response attribute Show response attribute object
- policies object Required
  
  Hide policies attribute Show policies attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  required_capacity object Required
  
  Hide required_capacity attributes Show required_capacity attributes object
  
  node object Required
  
  Hide node attributes Show node attributes object
  
  storage number Required
  
  memory number Required
  
  total object Required
  
  Hide total attributes Show total attributes object
  
  storage number Required
  
  memory number Required
  
  current_capacity object Required
  
  Hide current_capacity attributes Show current_capacity attributes object
  
  node object Required
  
  Hide node attributes Show node attributes object
  
  storage number Required
  
  memory number Required
  
  total object Required
  
  Hide total attributes Show total attributes object
  
  storage number Required
  
  memory number Required
  
  current_nodes array[object] Required
  
  Hide current_nodes attribute Show current_nodes attribute object
  
  name string Required
  
  deciders object Required
  
  Hide deciders attribute Show deciders attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  required_capacity object Required
  
  Hide required_capacity attributes Show required_capacity attributes object
  
  node object Required
  
  total object Required
  
  reason_summary string
  
  reason_details object

GET /_autoscaling/capacity

curl \
 --request GET 'http://api.example.com/_autoscaling/capacity' \
 --header "Authorization: $API_KEY"

Response examples (200)

This may be a response to `GET /_autoscaling/capacity`.

{
  policies: {}
}

Create a behavioral analytics collection Technical preview

PUT /_application/analytics/{name}

Api key auth Basic auth Bearer auth

Path parameters

name string Required

The name of the analytics collection to be created or updated.

Responses

200 application/json
Hide response attributes Show response attributes object
- acknowledged boolean Required
  
  For a successful response, this value is always true. On failure, an exception is returned instead.
- name string Required

PUT /_application/analytics/{name}

curl \
 --request PUT 'http://api.example.com/_application/analytics/{name}' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "acknowledged": true,
  "name": "string"
}

Create a behavioral analytics collection event Technical preview

POST /_application/analytics/{collection_name}/event/{event_type}

Api key auth Basic auth Bearer auth

External documentation

Path parameters

collection_name string Required

The name of the behavioral analytics collection.
event_type string Required

The analytics event type.

Values are page_view, search, or search_click.

Query parameters

debug boolean

Whether the response type has to include more details

application/json

Body Required

object

Responses

200 application/json
Hide response attributes Show response attributes object
- accepted boolean Required
- event object

POST /_application/analytics/{collection_name}/event/{event_type}

curl \
 --request POST 'http://api.example.com/_application/analytics/{collection_name}/event/{event_type}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"session\": {\n    \"id\": \"1797ca95-91c9-4e2e-b1bd-9c38e6f386a9\"\n  },\n  \"user\": {\n    \"id\": \"5f26f01a-bbee-4202-9298-81261067abbd\"\n  },\n  \"search\":{\n    \"query\": \"search term\",\n    \"results\": {\n      \"items\": [\n        {\n          \"document\": {\n            \"id\": \"123\",\n            \"index\": \"products\"\n          }\n        }\n      ],\n      \"total_results\": 10\n    },\n    \"sort\": {\n      \"name\": \"relevance\"\n    },\n    \"search_application\": \"website\"\n  },\n  \"document\":{\n    \"id\": \"123\",\n    \"index\": \"products\"\n  }\n}"'

Request example

Run `POST _application/analytics/my_analytics_collection/event/search_click` to send a `search_click` event to an analytics collection called `my_analytics_collection`.

{
  "session": {
    "id": "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9"
  },
  "user": {
    "id": "5f26f01a-bbee-4202-9298-81261067abbd"
  },
  "search":{
    "query": "search term",
    "results": {
      "items": [
        {
          "document": {
            "id": "123",
            "index": "products"
          }
        }
      ],
      "total_results": 10
    },
    "sort": {
      "name": "relevance"
    },
    "search_application": "website"
  },
  "document":{
    "id": "123",
    "index": "products"
  }
}

Response examples (200)

{
  "accepted": true,
  "event": {}
}

Get aliases

GET /_cat/aliases/{name}

Api key auth Basic auth Bearer auth

Get the cluster's index aliases, including filter and routing information. This API does not return data stream aliases.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.

Path parameters

name string | array[string] Required

A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

Query parameters

h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
expand_wildcards string | array[string]

The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden.
local boolean

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
master_timeout string

The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to -1.

Responses

200 application/json
Hide response attributes Show response attributes object
- alias string
  
  alias name
- index string
- filter string
  
  filter
- routing.index string
  
  index routing
- routing.search string
  
  search routing
- is_write_index string
  
  write index

GET /_cat/aliases/{name}

curl \
 --request GET 'http://api.example.com/_cat/aliases/{name}' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET _cat/aliases?format=json&v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.

[
  {
    "alias": "alias1",
    "index": "test1",
    "filter": "-",
    "routing.index": "-",
    "routing.search": "-",
    "is_write_index": "true"
  },
  {
    "alias": "alias1",
    "index": "test1",
    "filter": "*",
    "routing.index": "-",
    "routing.search": "-",
    "is_write_index": "true"
  },
  {
    "alias": "alias3",
    "index": "test1",
    "filter": "-",
    "routing.index": "1",
    "routing.search": "1",
    "is_write_index": "true"
  },
  {
    "alias": "alias4",
    "index": "test1",
    "filter": "-",
    "routing.index": "2",
    "routing.search": "1,2",
    "is_write_index": "true"
  }
]

Get shard allocation information

GET /_cat/allocation

Api key auth Basic auth Bearer auth

Get a snapshot of the number of shards allocated to each data node and their disk space.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

Query parameters

bytes string

The unit used to display byte values.

Values are b, kb, mb, gb, tb, or pb.
h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
local boolean

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
master_timeout string

Period to wait for a connection to the master node.

Responses

200 application/json
Hide response attributes Show response attributes object
- shards string
  
  Number of primary and replica shards assigned to the node.
- shards.undesired string | null
  
  Amount of shards that are scheduled to be moved elsewhere in the cluster or -1 other than desired balance allocator is used
  
  One of:
  string-1 string string-2 string | null
- write_load.forecast number | string | null
  
  Sum of index write load forecasts
  
  One of:
  Stringifieddouble number Stringifieddouble string string-2 string | null
- disk.indices.forecast number | string | null
  
  Sum of shard size forecasts
  
  One of:
  ByteSize number ByteSize string string-2 string | null
- disk.indices number | string | null
  
  Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards. IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index.
  
  One of:
  ByteSize number ByteSize string string-2 string | null
- disk.used number | string | null
  
  Total disk space in use. Elasticsearch retrieves this metric from the node’s operating system (OS). The metric includes disk space for: Elasticsearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node. Unlike disk.indices, this metric does not double-count disk space for hard-linked files.
  
  One of:
  ByteSize number ByteSize string string-2 string | null
- disk.avail number | string | null
  
  Free disk space available to Elasticsearch. Elasticsearch retrieves this metric from the node’s operating system. Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space.
  
  One of:
  ByteSize number ByteSize string string-2 string | null
- disk.total number | string | null
  
  Total disk space for the node, including in-use and available space.
  
  One of:
  ByteSize number ByteSize string string-2 string | null
- disk.percent string | number | null
  
  Total percentage of disk space in use. Calculated as disk.used / disk.total.
  
  One of:
  Percentage string Percentage number string-2 string | null
- host string | null
  
  Network host for the node. Set using the network.host setting.
  
  One of:
  Host string string-2 string | null
- ip string | null
  
  IP address and port for the node.
  
  One of:
  Ip string string-2 string | null
- node string
  
  Name for the node. Set using the node.name setting.
- node.role string | null
  
  Node roles
  
  One of:
  string-1 string string-2 string | null

GET /_cat/allocation

curl \
 --request GET 'http://api.example.com/_cat/allocation' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET /_cat/allocation?v=true&format=json`. It shows a single shard is allocated to the one node available.

[
  {
    "shards": "1",
    "shards.undesired": "0",
    "write_load.forecast": "0.0",
    "disk.indices.forecast": "260b",
    "disk.indices": "260b",
    "disk.used": "47.3gb",
    "disk.avail": "43.4gb",
    "disk.total": "100.7gb",
    "disk.percent": "46",
    "host": "127.0.0.1",
    "ip": "127.0.0.1",
    "node": "CSUXak2",
    "node.role": "himrst"
  }
]

Get shard allocation information

GET /_cat/allocation/{node_id}

Api key auth Basic auth Bearer auth

Get a snapshot of the number of shards allocated to each data node and their disk space.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

Path parameters

node_id string | array[string] Required

A comma-separated list of node identifiers or names used to limit the returned information.

Query parameters

bytes string

The unit used to display byte values.

Values are b, kb, mb, gb, tb, or pb.
h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
local boolean

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
master_timeout string

Period to wait for a connection to the master node.

Responses

200 application/json
Hide response attributes Show response attributes object
- shards string
  
  Number of primary and replica shards assigned to the node.
- shards.undesired string | null
  
  Amount of shards that are scheduled to be moved elsewhere in the cluster or -1 other than desired balance allocator is used
  
  One of:
  string-1 string string-2 string | null
- write_load.forecast number | string | null
  
  Sum of index write load forecasts
  
  One of:
  Stringifieddouble number Stringifieddouble string string-2 string | null
- disk.indices.forecast number | string | null
  
  Sum of shard size forecasts
  
  One of:
  ByteSize number ByteSize string string-2 string | null
- disk.indices number | string | null
  
  Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards. IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index.
  
  One of:
  ByteSize number ByteSize string string-2 string | null
- disk.used number | string | null
  
  Total disk space in use. Elasticsearch retrieves this metric from the node’s operating system (OS). The metric includes disk space for: Elasticsearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node. Unlike disk.indices, this metric does not double-count disk space for hard-linked files.
  
  One of:
  ByteSize number ByteSize string string-2 string | null
- disk.avail number | string | null
  
  Free disk space available to Elasticsearch. Elasticsearch retrieves this metric from the node’s operating system. Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space.
  
  One of:
  ByteSize number ByteSize string string-2 string | null
- disk.total number | string | null
  
  Total disk space for the node, including in-use and available space.
  
  One of:
  ByteSize number ByteSize string string-2 string | null
- disk.percent string | number | null
  
  Total percentage of disk space in use. Calculated as disk.used / disk.total.
  
  One of:
  Percentage string Percentage number string-2 string | null
- host string | null
  
  Network host for the node. Set using the network.host setting.
  
  One of:
  Host string string-2 string | null
- ip string | null
  
  IP address and port for the node.
  
  One of:
  Ip string string-2 string | null
- node string
  
  Name for the node. Set using the node.name setting.
- node.role string | null
  
  Node roles
  
  One of:
  string-1 string string-2 string | null

GET /_cat/allocation/{node_id}

curl \
 --request GET 'http://api.example.com/_cat/allocation/{node_id}' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET /_cat/allocation?v=true&format=json`. It shows a single shard is allocated to the one node available.

[
  {
    "shards": "1",
    "shards.undesired": "0",
    "write_load.forecast": "0.0",
    "disk.indices.forecast": "260b",
    "disk.indices": "260b",
    "disk.used": "47.3gb",
    "disk.avail": "43.4gb",
    "disk.total": "100.7gb",
    "disk.percent": "46",
    "host": "127.0.0.1",
    "ip": "127.0.0.1",
    "node": "CSUXak2",
    "node.role": "himrst"
  }
]

Get a document count

GET /_cat/count

Api key auth Basic auth Bearer auth

Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.

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 count API.

Query parameters

h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

Responses

200 application/json
Hide response attributes Show response attributes object
- epoch number | string
  
  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
  
  One of:
  UnitSeconds number StringifiedEpochTimeUnitSeconds string
  
  Time unit for seconds
- timestamp string
  
  Time of day, expressed as HH:MM:SS
- count string
  
  the document count

GET /_cat/count

curl \
 --request GET 'http://api.example.com/_cat/count' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET /_cat/count/my-index-000001?v=true&format=json`. It retrieves the document count for the `my-index-000001` data stream or index.

[
  {
    "epoch": "1475868259",
    "timestamp": "15:24:20",
    "count": "120"
  }
]

A successful response from `GET /_cat/count?v=true&format=json`. It retrieves the document count for all data streams and indices in the cluster.

[
  {
    "epoch": "1475868259",
    "timestamp": "15:24:20",
    "count": "121"
  }
]

Get the cluster health status

GET /_cat/health

Api key auth Basic auth Bearer auth

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 cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: HH:MM:SS, which is human-readable but includes no date information; Unix epoch time, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.

Query parameters

time string

The unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.
ts boolean

If true, returns HH:MM:SS and Unix epoch timestamps.
h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

Responses

200 application/json
Hide response attributes Show response attributes object
- epoch number | string
  
  Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.
  
  Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.
  
  One of:
  UnitSeconds number StringifiedEpochTimeUnitSeconds string
  
  Time unit for seconds
- timestamp string
  
  Time of day, expressed as HH:MM:SS
- cluster string
  
  cluster name
- status string
  
  health status
- node.total string
  
  total number of nodes
- node.data string
  
  number of nodes that can store data
- shards string
  
  total number of shards
- pri string
  
  number of primary shards
- relo string
  
  number of relocating nodes
- init string
  
  number of initializing nodes
- unassign.pri string
  
  number of unassigned primary shards
- unassign string
  
  number of unassigned shards
- pending_tasks string
  
  number of pending tasks
- max_task_wait_time string
  
  wait time of longest task pending
- active_shards_percent string
  
  active number of shards in percent

GET /_cat/health

curl \
 --request GET 'http://api.example.com/_cat/health' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET /_cat/health?v=true&format=json`. By default, it returns `HH:MM:SS` and Unix epoch timestamps.

[
  {
    "epoch": "1475871424",
    "timestamp": "16:17:04",
    "cluster": "elasticsearch",
    "status": "green",
    "node.total": "1",
    "node.data": "1",
    "shards": "1",
    "pri": "1",
    "relo": "0",
    "init": "0",
    "unassign": "0",
    "unassign.pri": "0",
    "pending_tasks": "0",
    "max_task_wait_time": "-",
    "active_shards_percent": "100.0%"
  }
]

Get data frame analytics jobs Added in 7.7.0

GET /_cat/ml/data_frame/analytics

Api key auth Basic auth Bearer auth

Get configuration and usage information about data frame analytics jobs.

IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.

Query parameters

allow_no_match boolean

Whether to ignore if a wildcard expression matches no configs. (This includes _all string or when no configs have been specified)
bytes string

The unit in which to display byte values

Values are b, kb, mb, gb, tb, or pb.
h string | array[string]

Comma-separated list of column names to display.
s string | array[string]

Comma-separated list of column names or column aliases used to sort the response.
time string

Unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
- type string
  
  The type of analysis that the job performs.
- create_time string
  
  The time when the job was created.
- version string
- source_index string
- dest_index string
- description string
  
  A description of the job.
- model_memory_limit string
  
  The approximate maximum amount of memory resources that are permitted for the job.
- state string
  
  The current status of the job.
- failure_reason string
  
  Messages about the reason why the job failed.
- progress string
  
  The progress report for the job by phase.
- assignment_explanation string
  
  Messages related to the selection of a node.
- node.id string
- node.name string
- node.ephemeral_id string
- node.address string
  
  The network address of the assigned node.

GET /_cat/ml/data_frame/analytics

curl \
 --request GET 'http://api.example.com/_cat/ml/data_frame/analytics' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET _cat/ml/data_frame/analytics?v=true&format=json`.

[
  {
    "id": "classifier_job_1",
    "type": "classification",
    "create_time": "2020-02-12T11:49:09.594Z",
    "state": "stopped"
  },
    {
    "id": "classifier_job_2",
    "type": "classification",
    "create_time": "2020-02-12T11:49:14.479Z",
    "state": "stopped"
  },
  {
    "id": "classifier_job_3",
    "type": "classification",
    "create_time": "2020-02-12T11:49:16.928Z",
    "state": "stopped"
  },
  {
    "id": "classifier_job_4",
    "type": "classification",
    "create_time": "2020-02-12T11:49:19.127Z",
    "state": "stopped"
  },
  {
    "id": "classifier_job_5",
    "type": "classification",
    "create_time": "2020-02-12T11:49:21.349Z",
    "state": "stopped"
  }
]

Get datafeeds Added in 7.7.0

GET /_cat/ml/datafeeds

Api key auth Basic auth Bearer auth

Get configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API.

IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.

Query parameters

allow_no_match boolean
Specifies what to do when the request:
- Contains wildcard expressions and there are no datafeeds that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches.
If true, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.
h string | array[string]

Comma-separated list of column names to display.
s string | array[string]

Comma-separated list of column names or column aliases used to sort the response.
time string

The unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
  
  The datafeed identifier.
- state string
  
  Values are started, stopped, starting, or stopping.
- assignment_explanation string
  
  For started datafeeds only, contains messages relating to the selection of a node.
- buckets.count string
  
  The number of buckets processed.
- search.count string
  
  The number of searches run by the datafeed.
- search.time string
  
  The total time the datafeed spent searching, in milliseconds.
- search.bucket_avg string
  
  The average search time per bucket, in milliseconds.
- search.exp_avg_hour string
  
  The exponential average search time per hour, in milliseconds.
- node.id string
  
  The unique identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.
- node.name string
  
  The name of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.
- node.ephemeral_id string
  
  The ephemeral identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.
- node.address string
  
  The network address of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.

GET /_cat/ml/datafeeds

curl \
 --request GET 'http://api.example.com/_cat/ml/datafeeds' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET _cat/ml/datafeeds?v=true&format=json`.

[
  {
    "id": "datafeed-high_sum_total_sales",
    "state": "stopped",
    "buckets.count": "743",
    "search.count": "7"
  },
  {
    "id": "datafeed-low_request_rate",
    "state": "stopped",
    "buckets.count": "1457",
    "search.count": "3"
  },
  {
    "id": "datafeed-response_code_rates",
    "state": "stopped",
    "buckets.count": "1460",
    "search.count": "18"
  },
  {
    "id": "datafeed-url_scanning",
    "state": "stopped",
    "buckets.count": "1460",
    "search.count": "18"
  }
]

Get datafeeds Added in 7.7.0

GET /_cat/ml/datafeeds/{datafeed_id}

Api key auth Basic auth Bearer auth

Get configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API.

IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.

Path parameters

datafeed_id string Required

A numerical character string that uniquely identifies the datafeed.

Query parameters

allow_no_match boolean
Specifies what to do when the request:
- Contains wildcard expressions and there are no datafeeds that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches.
If true, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.
h string | array[string]

Comma-separated list of column names to display.
s string | array[string]

Comma-separated list of column names or column aliases used to sort the response.
time string

The unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
  
  The datafeed identifier.
- state string
  
  Values are started, stopped, starting, or stopping.
- assignment_explanation string
  
  For started datafeeds only, contains messages relating to the selection of a node.
- buckets.count string
  
  The number of buckets processed.
- search.count string
  
  The number of searches run by the datafeed.
- search.time string
  
  The total time the datafeed spent searching, in milliseconds.
- search.bucket_avg string
  
  The average search time per bucket, in milliseconds.
- search.exp_avg_hour string
  
  The exponential average search time per hour, in milliseconds.
- node.id string
  
  The unique identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.
- node.name string
  
  The name of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.
- node.ephemeral_id string
  
  The ephemeral identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.
- node.address string
  
  The network address of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.

GET /_cat/ml/datafeeds/{datafeed_id}

curl \
 --request GET 'http://api.example.com/_cat/ml/datafeeds/{datafeed_id}' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET _cat/ml/datafeeds?v=true&format=json`.

[
  {
    "id": "datafeed-high_sum_total_sales",
    "state": "stopped",
    "buckets.count": "743",
    "search.count": "7"
  },
  {
    "id": "datafeed-low_request_rate",
    "state": "stopped",
    "buckets.count": "1457",
    "search.count": "3"
  },
  {
    "id": "datafeed-response_code_rates",
    "state": "stopped",
    "buckets.count": "1460",
    "search.count": "18"
  },
  {
    "id": "datafeed-url_scanning",
    "state": "stopped",
    "buckets.count": "1460",
    "search.count": "18"
  }
]

Get node information

GET /_cat/nodes

Api key auth Basic auth Bearer auth

Get information about the nodes in a cluster. 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.

Query parameters

bytes string

The unit used to display byte values.

Values are b, kb, mb, gb, tb, or pb.
full_id boolean | string

If true, return the full node ID. If false, return the shortened node ID.
include_unloaded_segments boolean

If true, the response includes information from segments that are not loaded into memory.
h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
master_timeout string

Period to wait for a connection to the master node.
time string

Unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
- pid string
  
  The process identifier.
- ip string
  
  The IP address.
- port string
  
  The bound transport port.
- http_address string
  
  The bound HTTP address.
- version string
- flavor string
  
  The Elasticsearch distribution flavor.
- type string
  
  The Elasticsearch distribution type.
- build string
  
  The Elasticsearch build hash.
- jdk string
  
  The Java version.
- disk.total number | string
  
  One of:
  ByteSize number ByteSize string
- disk.used number | string
  
  One of:
  ByteSize number ByteSize string
- disk.avail number | string
  
  One of:
  ByteSize number ByteSize string
- disk.used_percent string | number
  
  One of:
  Percentage string Percentage number
- heap.current string
  
  The used heap.
- heap.percent string | number
  
  One of:
  Percentage string Percentage number
- heap.max string
  
  The maximum configured heap.
- ram.current string
  
  The used machine memory.
- ram.percent string | number
  
  One of:
  Percentage string Percentage number
- ram.max string
  
  The total machine memory.
- file_desc.current string
  
  The used file descriptors.
- file_desc.percent string | number
  
  One of:
  Percentage string Percentage number
- file_desc.max string
  
  The maximum number of file descriptors.
- cpu string
  
  The recent system CPU usage as a percentage.
- load_1m string
  
  The load average for the most recent minute.
- load_5m string
  
  The load average for the last five minutes.
- load_15m string
  
  The load average for the last fifteen minutes.
- uptime string
  
  The node uptime.
- node.role string
  
  The roles of the node. Returned values include c(cold node), d(data node), f(frozen node), h(hot node), i(ingest node), l(machine learning node), m (master eligible node), r(remote cluster client node), s(content node), t(transform node), v(voting-only node), w(warm node),and -(coordinating node only).
- master string
  
  Indicates whether the node is the elected master node. Returned values include *(elected master) and -(not elected master).
- name string
- completion.size string
  
  The size of completion.
- fielddata.memory_size string
  
  The used fielddata cache.
- fielddata.evictions string
  
  The fielddata evictions.
- query_cache.memory_size string
  
  The used query cache.
- query_cache.evictions string
  
  The query cache evictions.
- query_cache.hit_count string
  
  The query cache hit counts.
- query_cache.miss_count string
  
  The query cache miss counts.
- request_cache.memory_size string
  
  The used request cache.
- request_cache.evictions string
  
  The request cache evictions.
- request_cache.hit_count string
  
  The request cache hit counts.
- request_cache.miss_count string
  
  The request cache miss counts.
- flush.total string
  
  The number of flushes.
- flush.total_time string
  
  The time spent in flush.
- get.current string
  
  The number of current get ops.
- get.time string
  
  The time spent in get.
- get.total string
  
  The number of get ops.
- get.exists_time string
  
  The time spent in successful gets.
- get.exists_total string
  
  The number of successful get operations.
- get.missing_time string
  
  The time spent in failed gets.
- get.missing_total string
  
  The number of failed gets.
- indexing.delete_current string
  
  The number of current deletions.
- indexing.delete_time string
  
  The time spent in deletions.
- indexing.delete_total string
  
  The number of delete operations.
- indexing.index_current string
  
  The number of current indexing operations.
- indexing.index_time string
  
  The time spent in indexing.
- indexing.index_total string
  
  The number of indexing operations.
- indexing.index_failed string
  
  The number of failed indexing operations.
- merges.current string
  
  The number of current merges.
- merges.current_docs string
  
  The number of current merging docs.
- merges.current_size string
  
  The size of current merges.
- merges.total string
  
  The number of completed merge operations.
- merges.total_docs string
  
  The docs merged.
- merges.total_size string
  
  The size merged.
- merges.total_time string
  
  The time spent in merges.
- refresh.total string
  
  The total refreshes.
- refresh.time string
  
  The time spent in refreshes.
- refresh.external_total string
  
  The total external refreshes.
- refresh.external_time string
  
  The time spent in external refreshes.
- refresh.listeners string
  
  The number of pending refresh listeners.
- script.compilations string
  
  The total script compilations.
- script.cache_evictions string
  
  The total compiled scripts evicted from the cache.
- script.compilation_limit_triggered string
  
  The script cache compilation limit triggered.
- search.fetch_current string
  
  The current fetch phase operations.
- search.fetch_time string
  
  The time spent in fetch phase.
- search.fetch_total string
  
  The total fetch operations.
- search.open_contexts string
  
  The open search contexts.
- search.query_current string
  
  The current query phase operations.
- search.query_time string
  
  The time spent in query phase.
- search.query_total string
  
  The total query phase operations.
- search.scroll_current string
  
  The open scroll contexts.
- search.scroll_time string
  
  The time scroll contexts held open.
- search.scroll_total string
  
  The completed scroll contexts.
- segments.count string
  
  The number of segments.
- segments.memory string
  
  The memory used by segments.
- segments.index_writer_memory string
  
  The memory used by the index writer.
- segments.version_map_memory string
  
  The memory used by the version map.
- segments.fixed_bitset_memory string
  
  The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields.
- suggest.current string
  
  The number of current suggest operations.
- suggest.time string
  
  The time spend in suggest.
- suggest.total string
  
  The number of suggest operations.
- bulk.total_operations string
  
  The number of bulk shard operations.
- bulk.total_time string
  
  The time spend in shard bulk.
- bulk.total_size_in_bytes string
  
  The total size in bytes of shard bulk.
- bulk.avg_time string
  
  The average time spend in shard bulk.
- bulk.avg_size_in_bytes string
  
  The average size in bytes of shard bulk.

GET /_cat/nodes

curl \
 --request GET 'http://api.example.com/_cat/nodes' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET /_cat/nodes?v=true&format=json`. The `ip`, `heap.percent`, `ram.percent`, `cpu`, and `load_*` columns provide the IP addresses and performance information of each node. The `node.role`, `master`, and `name` columns provide information useful for monitoring an entire cluster, particularly large ones.

[
  {
    "ip": "127.0.0.1",
    "heap.percent": "65",
    "ram.percent": "99",
    "cpu": "42",
    "load_1m": "3.07",
    "load_5m": null,
    "load_15m": null,
    "node.role": "cdfhilmrstw",
    "master": "*",
    "name": "mJw06l1"
  }
]

A successful response from `GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json`. It returns the `id`, `ip`, `port`, `v` (version), and `m` (master) columns.

[
  {
    "id": "veJR",
    "ip": "127.0.0.1",
    "port": "59938",
    "v": "9.0.0",
    "m": "*"
  }
]

Get pending task information

GET /_cat/pending_tasks

Api key auth Basic auth Bearer auth

Get information about cluster-level changes that have not yet taken effect. 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 pending cluster tasks API.

Query parameters

h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
local boolean

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
master_timeout string

Period to wait for a connection to the master node.
time string

Unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.

Responses

200 application/json
Hide response attributes Show response attributes object
- insertOrder string
  
  The task insertion order.
- timeInQueue string
  
  Indicates how long the task has been in queue.
- priority string
  
  The task priority.
- source string
  
  The task source.

GET /_cat/pending_tasks

curl \
 --request GET 'http://api.example.com/_cat/pending_tasks' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET /_cat/pending_tasks?v=trueh=insertOrder,timeInQueue,priority,source&format=json`.

[
  { "insertOrder": "1685", "timeInQueue": "855ms", "priority": "HIGH", "source": "update-mapping [foo][t]"},
    { "insertOrder": "1686", "timeInQueue": "843ms", "priority": "HIGH", "source": "update-mapping [foo][t]"},
    { "insertOrder": "1693", "timeInQueue": "753ms", "priority": "HIGH", "source": "refresh-mapping [foo][[t]]"},
    { "insertOrder": "1688", "timeInQueue": "816ms", "priority": "HIGH", "source": "update-mapping [foo][t]"},
    { "insertOrder": "1689", "timeInQueue": "802ms", "priority": "HIGH", "source": "update-mapping [foo][t]"},
    { "insertOrder": "1690", "timeInQueue": "787ms", "priority": "HIGH", "source": "update-mapping [foo][t]"},
    { "insertOrder": "1691", "timeInQueue": "773ms", "priority": "HIGH", "source": "update-mapping [foo][t]"}
]

Get plugin information

GET /_cat/plugins

Api key auth Basic auth Bearer auth

Get a list of plugins running on each node of a cluster. 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.

Query parameters

h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
include_bootstrap boolean

Include bootstrap plugins in the response
local boolean

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
master_timeout string

Period to wait for a connection to the master node.

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
- name string
- component string
  
  The component name.
- version string
- description string
  
  The plugin details.
- type string
  
  The plugin type.

GET /_cat/plugins

curl \
 --request GET 'http://api.example.com/_cat/plugins' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json`.

[
  { "name": "U7321H6", "component": "analysis-icu", "version": "8.17.0", "description": "The ICU Analysis plugin integrates the Lucene ICU module into Elasticsearch, adding ICU-related analysis components."},
  {"name": "U7321H6", "component": "analysis-kuromoji",   "verison":  "8.17.0", description: "The Japanese (kuromoji) Analysis plugin integrates Lucene kuromoji analysis module into elasticsearch."},
  {"name" "U7321H6", "component": "analysis-nori", "version":         "8.17.0", "description": "The Korean (nori) Analysis plugin integrates Lucene nori analysis module into elasticsearch."},
  {"name": "U7321H6", "component": "analysis-phonetic",   "verison":  "8.17.0", "description": "The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch."},
  {"name": "U7321H6", "component": "analysis-smartcn",   "verison":  "8.17.0", "description": "Smart Chinese Analysis plugin integrates Lucene Smart Chinese analysis module into elasticsearch."},
  {"name": "U7321H6", "component": "analysis-stempel",   "verison":  "8.17.0", "description": "The Stempel (Polish) Analysis plugin integrates Lucene stempel (polish) analysis module into elasticsearch."},
  {"name": "U7321H6", "component": "analysis-ukrainian",   "verison":  "8.17.0", "description": "The Ukrainian Analysis plugin integrates the Lucene UkrainianMorfologikAnalyzer into elasticsearch."},
  {"name": "U7321H6", "component": "discovery-azure-classic",   "verison":  "8.17.0", "description": "The Azure Classic Discovery plugin allows to use Azure Classic API for the unicast discovery mechanism"},
  {"name": "U7321H6", "component": "discovery-ec2",   "verison":  "8.17.0", "description": "The EC2 discovery plugin allows to use AWS API for the unicast discovery mechanism."},
  {"name": "U7321H6", "component": "discovery-gce",   "verison":  "8.17.0", "description": "The Google Compute Engine (GCE) Discovery plugin allows to use GCE API for the unicast discovery mechanism."},
  {"name": "U7321H6", "component": "mapper-annotated-text",   "verison":  "8.17.0", "description": "The Mapper Annotated_text plugin adds support for text fields with markup used to inject annotation tokens into the index."},
  {"name": "U7321H6", "component": "mapper-murmur3",   "verison":  "8.17.0", "description": "The Mapper Murmur3 plugin allows to compute hashes of a field's values at index-time and to store them in the index."},
  {"name": "U7321H6", "component": "mapper-size",   "verison":  "8.17.0", "description": "The Mapper Size plugin allows document to record their uncompressed size at index time."},
  {"name": "U7321H6", "component": "store-smb",   "verison":  "8.17.0", "description": "The Store SMB plugin adds support for SMB stores."}
]

Get task information Technical preview

GET /_cat/tasks

Api key auth Basic auth Bearer auth

Get information about tasks currently running in the cluster. 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 task management API.

Query parameters

actions array[string]

The task action names, which are used to limit the response.
detailed boolean

If true, the response includes detailed information about shard recoveries.
nodes array[string]

Unique node identifiers, which are used to limit the response.
parent_task_id string

The parent task identifier, which is used to limit the response.
h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
time string

Unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.
timeout string

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

If true, the request blocks until the task has completed.

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
- action string
  
  The task action.
- task_id string
- parent_task_id string
  
  The parent task identifier.
- type string
  
  The task type.
- start_time string
  
  The start time in milliseconds.
- timestamp string
  
  The start time in HH:MM:SS format.
- running_time_ns string
  
  The running time in nanoseconds.
- running_time string
  
  The running time.
- node_id string
- ip string
  
  The IP address for the node.
- port string
  
  The bound transport port for the node.
- node string
  
  The node name.
- version string
- x_opaque_id string
  
  The X-Opaque-ID header.
- description string
  
  The task action description.

GET /_cat/tasks

curl \
 --request GET 'http://api.example.com/_cat/tasks' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET _cat/tasks?v=true&format=json`.

[
  {
    "action": "cluster:monitor/tasks/lists[n]",
    "task_id": "oTUltX4IQMOUUVeiohTt8A:124",
    "parent_task_id": "oTUltX4IQMOUUVeiohTt8A:123",
    "type": "direct",
    "start_time": "1458585884904",
    "timestamp": "01:48:24",
    "running_time": "44.1micros",
    "ip": "127.0.0.1:9300",
    "node": "oTUltX4IQMOUUVeiohTt8A"
  },
  {
    "action": "cluster:monitor/tasks/lists",
    "task_id": "oTUltX4IQMOUUVeiohTt8A:123",
    "parent_task_id": "-",
    "type": "transport",
    "start_time": "1458585884904",
    "timestamp": "01:48:24",
    "running_time": "186.2micros",
    "ip": "127.0.0.1:9300",
    "node": "oTUltX4IQMOUUVeiohTt8A"
  }
]

Get index template information Added in 5.2.0

GET /_cat/templates/{name}

Api key auth Basic auth Bearer auth

Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. 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 get index template API.

Path parameters

name string Required

The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.

Query parameters

h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
local boolean

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
master_timeout string

Period to wait for a connection to the master node.

Responses

200 application/json
Hide response attributes Show response attributes object
- name string
- index_patterns string
  
  The template index patterns.
- order string
  
  The template application order or priority number.
- version string | null
  
  The template version.
  
  One of:
  VersionString string string-2 string | null
- composed_of string
  
  The component templates that comprise the index template.

GET /_cat/templates/{name}

curl \
 --request GET 'http://api.example.com/_cat/templates/{name}' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET _cat/templates/my-template-*?v=true&s=name&format=json`.

[
  {
    "name": "my-template-0",
    "index_patterns": "[te*]",
    "order": "500",
    "version": null,
    "composed_of": "[]"
  },
  {
    "name": "my-template-1",
    "index_patterns": "[tea*]",
    "order": "501",
    "version": null,
    "composed_of": "[]"
  },
  {
    "name": "my-template-2",
    "index_patterns": "[teak*]",
    "order": "502",
    "version": "7",
    "composed_of": "[]"
  }
]

Get thread pool statistics

GET /_cat/thread_pool/{thread_pool_patterns}

Api key auth Basic auth Bearer auth

Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. 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.

Path parameters

thread_pool_patterns string | array[string] Required

A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.

Query parameters

h string | array[string]

List of columns to appear in the response. Supports simple wildcards.
s string | array[string]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
time string

The unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.
local boolean

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
master_timeout string

Period to wait for a connection to the master node.

Responses

200 application/json
Hide response attributes Show response attributes object
- node_name string
  
  The node name.
- node_id string
- ephemeral_node_id string
  
  The ephemeral node identifier.
- pid string
  
  The process identifier.
- host string
  
  The host name for the current node.
- ip string
  
  The IP address for the current node.
- port string
  
  The bound transport port for the current node.
- name string
  
  The thread pool name.
- type string
  
  The thread pool type. Returned values include fixed, fixed_auto_queue_size, direct, and scaling.
- active string
  
  The number of active threads in the current thread pool.
- pool_size string
  
  The number of threads in the current thread pool.
- queue string
  
  The number of tasks currently in queue.
- queue_size string
  
  The maximum number of tasks permitted in the queue.
- rejected string
  
  The number of rejected tasks.
- largest string
  
  The highest number of active threads in the current thread pool.
- completed string
  
  The number of completed tasks.
- core string | null
  
  The core number of active threads allowed in a scaling thread pool.
  
  One of:
  string-1 string string-2 string | null
- max string | null
  
  The maximum number of active threads allowed in a scaling thread pool.
  
  One of:
  string-1 string string-2 string | null
- size string | null
  
  The number of active threads allowed in a fixed thread pool.
  
  One of:
  string-1 string string-2 string | null
- keep_alive string | null
  
  The thread keep alive time.
  
  One of:
  string-1 string string-2 string | null

GET /_cat/thread_pool/{thread_pool_patterns}

curl \
 --request GET 'http://api.example.com/_cat/thread_pool/{thread_pool_patterns}' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET /_cat/thread_pool?format=json`.

[
  {
    "node_name": "node-0",
    "name": "analyze",
    "active": "0",
    "queue": "0",
    "rejected": "0"
  },
  {
    "node_name": "node-0",
    "name": "fetch_shard_started",
    "active": "0",
    "queue": "0",
    "rejected": "0"
  },
  {
    "node_name": "node-0",
    "name": "fetch_shard_store",
    "active": "0",
    "queue": "0",
    "rejected": "0"
  },
  {
    "node_name": "node-0",
    "name": "flush",
    "active": "0",
    "queue": "0",
    "rejected": "0"
  },
  {
    "node_name": "node-0",
    "name": "write",
    "active": "0",
    "queue": "0",
    "rejected": "0"
  }
]

A successful response from `GET /_cat/thread_pool/generic?v=true&h=id,name,active,rejected,completed&format=json`. It returns the `id`, `name`, `active`, `rejected`, and `completed` columns. It also limits returned information to the generic thread pool.

[
  {
    "id": "0EWUhXeBQtaVGlexUeVwMg",
    "name": "generic",
    "active": "0",
    "rejected": "0",
    "completed": "70"
  }
]

Get transform information Added in 7.7.0

GET /_cat/transforms

Api key auth Basic auth Bearer auth

Get configuration and usage information about transforms.

CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.

Query parameters

allow_no_match boolean

Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If true, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If false, the request returns a 404 status code when there are no matches or only partial matches.
from number

Skips the specified number of transforms.
h string | array[string]

Comma-separated list of column names to display.
s string | array[string]

Comma-separated list of column names or column aliases used to sort the response.
time string

The unit used to display time values.

Values are nanos, micros, ms, s, m, h, or d.
size number

The maximum number of transforms to obtain.

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
- state string
  
  The status of the transform. Returned values include: aborting: The transform is aborting. failed: The transform failed. For more information about the failure, check thereasonfield.indexing: The transform is actively processing data and creating new documents.started: The transform is running but not actively indexing data.stopped: The transform is stopped.stopping`: The transform is stopping.
- checkpoint string
  
  The sequence number for the checkpoint.
- documents_processed string
  
  The number of documents that have been processed from the source index of the transform.
- checkpoint_progress string | null
  
  The progress of the next checkpoint that is currently in progress.
  
  One of:
  string-1 string string-2 string | null
- last_search_time string | null
  
  The timestamp of the last search in the source indices. This field is shown only if the transform is running.
  
  One of:
  string-1 string string-2 string | null
- changes_last_detection_time string | null
  
  The timestamp when changes were last detected in the source indices.
  
  One of:
  string-1 string string-2 string | null
- create_time string
  
  The time the transform was created.
- version string
- source_index string
  
  The source indices for the transform.
- dest_index string
  
  The destination index for the transform.
- pipeline string
  
  The unique identifier for the ingest pipeline.
- description string
  
  The description of the transform.
- transform_type string
  
  The type of transform: batch or continuous.
- frequency string
  
  The interval between checks for changes in the source indices when the transform is running continuously.
- max_page_search_size string
  
  The initial page size that is used for the composite aggregation for each checkpoint.
- docs_per_second string
  
  The number of input documents per second.
- reason string
  
  If a transform has a failed state, these details describe the reason for failure.
- search_total string
  
  The total number of search operations on the source index for the transform.
- search_failure string
  
  The total number of search failures.
- search_time string
  
  The total amount of search time, in milliseconds.
- index_total string
  
  The total number of index operations done by the transform.
- index_failure string
  
  The total number of indexing failures.
- index_time string
  
  The total time spent indexing documents, in milliseconds.
- documents_indexed string
  
  The number of documents that have been indexed into the destination index for the transform.
- delete_time string
  
  The total time spent deleting documents, in milliseconds.
- documents_deleted string
  
  The number of documents deleted from the destination index due to the retention policy for the transform.
- trigger_count string
  
  The number of times the transform has been triggered by the scheduler. For example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the frequency property.
- pages_processed string
  
  The number of search or bulk index operations processed. Documents are processed in batches instead of individually.
- processing_time string
  
  The total time spent processing results, in milliseconds.
- checkpoint_duration_time_exp_avg string
  
  The exponential moving average of the duration of the checkpoint, in milliseconds.
- indexed_documents_exp_avg string
  
  The exponential moving average of the number of new documents that have been indexed.
- processed_documents_exp_avg string
  
  The exponential moving average of the number of documents that have been processed.

GET /_cat/transforms

curl \
 --request GET 'http://api.example.com/_cat/transforms' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET /_cat/transforms?v=true&format=json`.

[
  {
    "id" : "ecommerce_transform",
    "state" : "started",
    "checkpoint" : "1",
    "documents_processed" : "705",
    "checkpoint_progress" : "100.00",
    "changes_last_detection_time" : null
  }
]

Explain the shard allocations Added in 5.0.0

POST /_cluster/allocation/explain

Api key auth Basic auth Bearer auth

Get explanations for shard allocations in the cluster. For unassigned shards, it provides an explanation for why the shard is unassigned. For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.

Query parameters

include_disk_info boolean

If true, returns information about disk usage and shard sizes.
include_yes_decisions boolean

If true, returns YES decisions in explanation.
master_timeout string

Period to wait for a connection to the master node.

application/json

Body

current_node string

Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node.
index string
primary boolean

If true, returns explanation for the primary shard for the given shard ID.
shard number

Specifies the ID of the shard that you would like an explanation for.

Responses

200 application/json
Hide response attributes Show response attributes object
- allocate_explanation string
- allocation_delay string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
- allocation_delay_in_millis number
  
  Time unit for milliseconds
- can_allocate string
  
  Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.
- can_move_to_other_node string
  
  Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.
- can_rebalance_cluster string
  
  Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.
- can_rebalance_cluster_decisions array[object]
  
  Hide can_rebalance_cluster_decisions attributes Show can_rebalance_cluster_decisions attributes object
  
  decider string Required
  
  decision string Required
  
  Values are NO, YES, THROTTLE, or ALWAYS.
  
  explanation string Required
- can_rebalance_to_other_node string
  
  Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.
- can_remain_decisions array[object]
  
  Hide can_remain_decisions attributes Show can_remain_decisions attributes object
  
  decider string Required
  
  decision string Required
  
  Values are NO, YES, THROTTLE, or ALWAYS.
  
  explanation string Required
- can_remain_on_current_node string
  
  Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.
- cluster_info object
  
  Hide cluster_info attributes Show cluster_info attributes object
  
  nodes object Required
  
  Hide nodes attribute Show nodes attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  node_name string Required
  
  least_available object Required
  
  Hide least_available attributes Show least_available attributes object
  
  path string Required
  
  total_bytes number Required
  
  used_bytes number Required
  
  free_bytes number Required
  
  free_disk_percent number Required
  
  used_disk_percent number Required
  
  most_available object Required
  
  Hide most_available attributes Show most_available attributes object
  
  path string Required
  
  total_bytes number Required
  
  used_bytes number Required
  
  free_bytes number Required
  
  free_disk_percent number Required
  
  used_disk_percent number Required
  
  shard_sizes object Required
  
  Hide shard_sizes attribute Show shard_sizes attribute object
  
  * number Additional properties
  
  shard_data_set_sizes object
  
  Hide shard_data_set_sizes attribute Show shard_data_set_sizes attribute object
  
  * string Additional properties
  
  shard_paths object Required
  
  Hide shard_paths attribute Show shard_paths attribute object
  
  * string Additional properties
  
  reserved_sizes array[object] Required
  
  Hide reserved_sizes attributes Show reserved_sizes attributes object
  
  node_id string Required
  
  path string Required
  
  total number Required
  
  shards array[string] Required
- configured_delay string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
- configured_delay_in_millis number
  
  Time unit for milliseconds
- current_node object
  
  Hide current_node attributes Show current_node attributes object
  
  id string Required
  
  name string Required
  
  roles array[string] Required
  
  @doc_id node-roles
  
  Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.
  
  attributes object Required
  
  Hide attributes attribute Show attributes attribute object
  
  * string Additional properties
  
  transport_address string Required
  
  weight_ranking number Required
- current_state string Required
- index string Required
- move_explanation string
- node_allocation_decisions array[object]
  
  Hide node_allocation_decisions attributes Show node_allocation_decisions attributes object
  
  deciders array[object] Required
  
  Hide deciders attributes Show deciders attributes object
  
  decider string Required
  
  decision string Required
  
  Values are NO, YES, THROTTLE, or ALWAYS.
  
  explanation string Required
  
  node_attributes object Required
  
  Hide node_attributes attribute Show node_attributes attribute object
  
  * string Additional properties
  
  node_decision string Required
  
  Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.
  
  node_id string Required
  
  node_name string Required
  
  roles array[string] Required
  
  @doc_id node-roles
  
  Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.
  
  store object
  
  Hide store attributes Show store attributes object
  
  allocation_id string Required
  
  found boolean Required
  
  in_sync boolean Required
  
  matching_size_in_bytes number Required
  
  matching_sync_id boolean Required
  
  store_exception string Required
  
  transport_address string Required
  
  weight_ranking number Required
- primary boolean Required
- rebalance_explanation string
- remaining_delay string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
- remaining_delay_in_millis number
  
  Time unit for milliseconds
- shard number Required
- unassigned_info object
  
  Hide unassigned_info attributes Show unassigned_info attributes object
  
  at string | number Required
  
  A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
  
  One of:
  DateTime string UnitMillis number
  
  last_allocation_status string
  
  reason string Required
  
  Values are INDEX_CREATED, CLUSTER_RECOVERED, INDEX_REOPENED, DANGLING_INDEX_IMPORTED, NEW_INDEX_RESTORED, EXISTING_INDEX_RESTORED, REPLICA_ADDED, ALLOCATION_FAILED, NODE_LEFT, REROUTE_CANCELLED, REINITIALIZED, REALLOCATED_REPLICA, PRIMARY_FAILED, FORCED_EMPTY_PRIMARY, or MANUAL_ALLOCATION.
  
  details string
  
  failed_allocation_attempts number
  
  delayed boolean
  
  allocation_status string
- note string

POST /_cluster/allocation/explain

curl \
 --request POST 'http://api.example.com/_cluster/allocation/explain' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"index\": \"my-index-000001\",\n  \"shard\": 0,\n  \"primary\": false,\n  \"current_node\": \"my-node\"\n}"'

Request example

Run `GET _cluster/allocation/explain` to get an explanation for a shard's current allocation.

{
  "index": "my-index-000001",
  "shard": 0,
  "primary": false,
  "current_node": "my-node"
}

Response examples (200)

An example of an allocation explanation for an unassigned primary shard. In this example, a newly created index has an index setting that requires that it only be allocated to a node named `nonexistent_node`, which does not exist, so the index is unable to allocate.

{
  "index" : "my-index-000001",
  "shard" : 0,
  "primary" : true,
  "current_state" : "unassigned",
  "unassigned_info" : {
    "reason" : "INDEX_CREATED",
    "at" : "2017-01-04T18:08:16.600Z",
    "last_allocation_status" : "no"
  },
  "can_allocate" : "no",
  "allocate_explanation" : "Elasticsearch isn't allowed to allocate this shard to any of the nodes in the cluster. Choose a node to which you expect this shard to be allocated, find this node in the node-by-node explanation, and address the reasons which prevent Elasticsearch from allocating this shard there.",
  "node_allocation_decisions" : [
    {
      "node_id" : "8qt2rY-pT6KNZB3-hGfLnw",
      "node_name" : "node-0",
      "transport_address" : "127.0.0.1:9401",
      "roles" : ["data", "data_cold", "data_content", "data_frozen", "data_hot", "data_warm", "ingest", "master", "ml", "remote_cluster_client", "transform"],
      "node_attributes" : {},
      "node_decision" : "no",
      "weight_ranking" : 1,
      "deciders" : [
        {
          "decider" : "filter",
          "decision" : "NO",
          "explanation" : "node does not match index setting [index.routing.allocation.include] filters [_name:\"nonexistent_node\"]"
        }
      ]
    }
  ]
}

An example of an allocation explanation for an unassigned primary shard that has reached the maximum number of allocation retry attempts. After the maximum number of retries is reached, Elasticsearch stops attempting to allocate the shard in order to prevent infinite retries which may impact cluster performance.

{
  "index" : "my-index-000001",
  "shard" : 0,
  "primary" : true,
  "current_state" : "unassigned",
  "unassigned_info" : {
    "at" : "2017-01-04T18:03:28.464Z",
    "failed shard on node [mEKjwwzLT1yJVb8UxT6anw]: failed recovery, failure RecoveryFailedException",
    "reason": "ALLOCATION_FAILED",
    "failed_allocation_attempts": 5,
    "last_allocation_status": "no",
  },
  "can_allocate": "no",
  "allocate_explanation": "cannot allocate because allocation is not permitted to any of the nodes",
  "node_allocation_decisions" : [
    {
      "node_id" : "3sULLVJrRneSg0EfBB-2Ew",
      "node_name" : "node_t0",
      "transport_address" : "127.0.0.1:9400",
      "roles" : ["data_content", "data_hot"],
      "node_decision" : "no",
      "store" : {
        "matching_size" : "4.2kb",
        "matching_size_in_bytes" : 4325
      },
      "deciders" : [
        {
          "decider": "max_retry",
          "decision" : "NO",
          "explanation": "shard has exceeded the maximum number of retries [5] on failed allocation attempts - manually call [POST /_cluster/reroute?retry_failed] to retry, [unassigned_info[[reason=ALLOCATION_FAILED], at[2024-07-30T21:04:12.166Z], failed_attempts[5], failed_nodes[[mEKjwwzLT1yJVb8UxT6anw]], delayed=false, details[failed shard on node [mEKjwwzLT1yJVb8UxT6anw]: failed recovery, failure RecoveryFailedException], allocation_status[deciders_no]]]"
        }
      ]
    }
  ]
}

Get the cluster health status Added in 1.3.0

GET /_cluster/health

Api key auth Basic auth Bearer auth

You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.

The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated. The index level status is controlled by the worst shard status.

One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. The cluster status is controlled by the worst index status.

Query parameters

expand_wildcards string | array[string]

Whether to expand wildcard expression to concrete indices that are open, closed or both.
level string

Can be one of cluster, indices or shards. Controls the details level of the health information returned.

Values are cluster, indices, or shards.
local boolean

If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
master_timeout string

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

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

A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.
wait_for_events string

Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.

Values are immediate, urgent, high, normal, low, or languid.
wait_for_nodes string | number

The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation.
wait_for_no_initializing_shards boolean

A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards.
wait_for_no_relocating_shards boolean

A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards.
wait_for_status string

One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status.

Values are green, GREEN, yellow, YELLOW, red, or RED.

Responses

200 application/json
Hide response attributes Show response attributes object
- active_primary_shards number Required
  
  The number of active primary shards.
- active_shards number Required
  
  The total number of active primary and replica shards.
- active_shards_percent string
  
  The ratio of active shards in the cluster expressed as a string formatted percentage.
- active_shards_percent_as_number number Required
  
  The ratio of active shards in the cluster expressed as a percentage.
- cluster_name string Required
- delayed_unassigned_shards number Required
  
  The number of shards whose allocation has been delayed by the timeout settings.
- indices object
  
  Hide indices attribute Show indices attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  active_primary_shards number Required
  
  active_shards number Required
  
  initializing_shards number Required
  
  number_of_replicas number Required
  
  number_of_shards number Required
  
  relocating_shards number Required
  
  shards object
  
  Hide shards attribute Show shards attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  active_shards number Required
  
  initializing_shards number Required
  
  primary_active boolean Required
  
  relocating_shards number Required
  
  status string Required
  
  Values are green, GREEN, yellow, YELLOW, red, or RED.
  
  unassigned_shards number Required
  
  unassigned_primary_shards number Required
  
  status string Required
  
  Values are green, GREEN, yellow, YELLOW, red, or RED.
  
  unassigned_shards number Required
  
  unassigned_primary_shards number Required
- initializing_shards number Required
  
  The number of shards that are under initialization.
- number_of_data_nodes number Required
  
  The number of nodes that are dedicated data nodes.
- number_of_in_flight_fetch number Required
  
  The number of unfinished fetches.
- number_of_nodes number Required
  
  The number of nodes within the cluster.
- number_of_pending_tasks number Required
  
  The number of cluster-level changes that have not yet been executed.
- relocating_shards number Required
  
  The number of shards that are under relocation.
- status string Required
  
  Values are green, GREEN, yellow, YELLOW, red, or RED.
- task_max_waiting_in_queue string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
- task_max_waiting_in_queue_millis number
  
  Time unit for milliseconds
- timed_out boolean Required
  
  If false the response returned within the period of time that is specified by the timeout parameter (30s by default)
- unassigned_primary_shards number Required
  
  The number of primary shards that are not allocated.
- unassigned_shards number Required
  
  The number of shards that are not allocated.

GET /_cluster/health

curl \
 --request GET 'http://api.example.com/_cluster/health' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `GET _cluster/health`. It is the health status of a quiet single node cluster with a single index with one shard and one replica.

{
  "cluster_name" : "testcluster",
  "status" : "yellow",
  "timed_out" : false,
  "number_of_nodes" : 1,
  "number_of_data_nodes" : 1,
  "active_primary_shards" : 1,
  "active_shards" : 1,
  "relocating_shards" : 0,
  "initializing_shards" : 0,
  "unassigned_shards" : 1,
  "delayed_unassigned_shards": 0,
  "number_of_pending_tasks" : 0,
  "number_of_in_flight_fetch": 0,
  "task_max_waiting_in_queue_millis": 0,
  "active_shards_percent_as_number": 50.0
}

Get the pending cluster tasks

GET /_cluster/pending_tasks

Api key auth Basic auth Bearer auth

Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.

NOTE: This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.

Query parameters

local boolean

If true, the request retrieves information from the local node only. If false, information is retrieved from the master node.
master_timeout string

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

Responses

200 application/json
Hide response attribute Show response attribute object
- tasks array[object] Required
  
  Hide tasks attributes Show tasks attributes object
  
  executing boolean Required
  
  Indicates whether the pending tasks are currently executing or not.
  
  insert_order number Required
  
  The number that represents when the task has been inserted into the task queue.
  
  priority string Required
  
  The priority of the pending task. The valid priorities in descending priority order are: IMMEDIATE > URGENT > HIGH > NORMAL > LOW > LANGUID.
  
  source string Required
  
  A general description of the cluster task that may include a reason and origin.
  
  time_in_queue string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  time_in_queue_millis number
  
  Time unit for milliseconds

GET /_cluster/pending_tasks

curl \
 --request GET 'http://api.example.com/_cluster/pending_tasks' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "tasks": [
    {
      "executing": true,
      "insert_order": 42.0,
      "priority": "string",
      "source": "string",
      "time_in_queue": "string",
      "": 42.0
    }
  ]
}

Get remote cluster information Added in 6.1.0

GET /_remote/info

Api key auth Basic auth Bearer auth

Get information about configured remote clusters. The API returns connection and endpoint information keyed by the configured remote cluster alias.

This API returns information that reflects current state on the local cluster. The connected field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it. Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster. To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the resolve cluster endpoint.

External documentation

Responses

200 application/json

GET /_remote/info

curl \
 --request GET 'http://api.example.com/_remote/info' \
 --header "Authorization: $API_KEY"

Response examples (200)

{}

Get the cluster state Added in 1.3.0

GET /_cluster/state/{metric}

Api key auth Basic auth Bearer auth

Get comprehensive information about the state of the cluster.

The cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster.

The elected master node ensures that every node in the cluster has a copy of the same cluster state. This API lets you retrieve a representation of this internal state for debugging or diagnostic purposes. You may need to consult the Elasticsearch source code to determine the precise meaning of the response.

By default the API will route requests to the elected master node since this node is the authoritative source of cluster states. You can also retrieve the cluster state held on the node handling the API request by adding the ?local=true query parameter.

Elasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data. If you use this API repeatedly, your cluster may become unstable.

WARNING: The response is a representation of an internal data structure. Its format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version. Do not query this API using external monitoring tools. Instead, obtain the information you require using other more stable cluster APIs.

Path parameters

metric string | array[string] Required

Limit the information returned to the specified metrics

Query parameters

allow_no_indices boolean

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)
expand_wildcards string | array[string]

Whether to expand wildcard expression to concrete indices that are open, closed or both.
flat_settings boolean

Return settings in flat format (default: false)
ignore_unavailable boolean

Whether specified concrete indices should be ignored when unavailable (missing or closed)
local boolean

Return local information, do not retrieve the state from master node (default: false)
master_timeout string

Specify timeout for connection to master
wait_for_metadata_version number

Wait for the metadata version to be equal or greater than the specified metadata version
wait_for_timeout string

The maximum time to wait for wait_for_metadata_version before timing out

Responses

200 application/json

GET /_cluster/state/{metric}

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

Response examples (200)

{}

Get cluster statistics Added in 1.3.0

GET /_cluster/stats

Api key auth Basic auth Bearer auth

Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).

Query parameters

include_remotes boolean

Include remote cluster data into the response
timeout string

Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout.

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string
  
  A human-readable explanation of the error, in English.
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  root_cause array[object]
  
  suppressed array[object]
  
  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
- cluster_uuid string Required
- indices object Required
  
  Hide indices attributes Show indices attributes object
  
  analysis object Required
  
  Hide analysis attributes Show analysis attributes object
  
  analyzer_types array[object] Required
  
  Contains statistics about analyzer types used in selected nodes.
  
  Hide analyzer_types attributes Show analyzer_types attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  built_in_analyzers array[object] Required
  
  Contains statistics about built-in analyzers used in selected nodes.
  
  Hide built_in_analyzers attributes Show built_in_analyzers attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  built_in_char_filters array[object] Required
  
  Contains statistics about built-in character filters used in selected nodes.
  
  Hide built_in_char_filters attributes Show built_in_char_filters attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  built_in_filters array[object] Required
  
  Contains statistics about built-in token filters used in selected nodes.
  
  Hide built_in_filters attributes Show built_in_filters attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  built_in_tokenizers array[object] Required
  
  Contains statistics about built-in tokenizers used in selected nodes.
  
  Hide built_in_tokenizers attributes Show built_in_tokenizers attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  char_filter_types array[object] Required
  
  Contains statistics about character filter types used in selected nodes.
  
  Hide char_filter_types attributes Show char_filter_types attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  filter_types array[object] Required
  
  Contains statistics about token filter types used in selected nodes.
  
  Hide filter_types attributes Show filter_types attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  tokenizer_types array[object] Required
  
  Contains statistics about tokenizer types used in selected nodes.
  
  Hide tokenizer_types attributes Show tokenizer_types attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  completion object Required
  
  Hide completion attributes Show completion attributes object
  
  size_in_bytes number Required
  
  Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
  
  size number | string
  
  One of:
  ByteSize number ByteSize string
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  size
  
  size_in_bytes number Required
  
  count number Required
  
  Total number of indices with shards assigned to selected nodes.
  
  docs object Required
  
  Hide docs attributes Show docs attributes object
  
  count number Required
  
  Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.
  
  deleted number
  
  Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
  
  fielddata object Required
  
  Hide fielddata attributes Show fielddata attributes object
  
  evictions number
  
  memory_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_size_in_bytes number Required
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  memory_size
  
  memory_size_in_bytes number Required
  
  query_cache object Required
  
  Hide query_cache attributes Show query_cache attributes object
  
  cache_count number Required
  
  Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.
  
  cache_size number Required
  
  Total number of entries currently in the query cache across all shards assigned to selected nodes.
  
  evictions number Required
  
  Total number of query cache evictions across all shards assigned to selected nodes.
  
  hit_count number Required
  
  Total count of query cache hits across all shards assigned to selected nodes.
  
  memory_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_size_in_bytes number Required
  
  Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
  
  miss_count number Required
  
  Total count of query cache misses across all shards assigned to selected nodes.
  
  total_count number Required
  
  Total count of hits and misses in the query cache across all shards assigned to selected nodes.
  
  segments object Required
  
  Hide segments attributes Show segments attributes object
  
  count number Required
  
  Total number of segments across all shards assigned to selected nodes.
  
  doc_values_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  doc_values_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
  
  file_sizes object Required
  
  This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
  
  Hide file_sizes attribute Show file_sizes attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  description string Required
  
  size_in_bytes number Required
  
  min_size_in_bytes number
  
  max_size_in_bytes number
  
  average_size_in_bytes number
  
  count number
  
  fixed_bit_set number | string
  
  One of:
  ByteSize number ByteSize string
  
  fixed_bit_set_memory_in_bytes number Required
  
  Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
  
  index_writer_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  index_writer_max_memory_in_bytes number
  
  index_writer_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
  
  max_unsafe_auto_id_timestamp number Required
  
  Unix timestamp, in milliseconds, of the most recently retried indexing request.
  
  memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
  
  norms_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  norms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
  
  points_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  points_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
  
  stored_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  stored_fields_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
  
  terms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
  
  terms_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  term_vectory_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  term_vectors_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
  
  version_map_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  version_map_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
  
  shards object Required
  
  Hide shards attributes Show shards attributes object
  
  index object
  
  Hide index attributes Show index attributes object
  
  primaries object Required
  
  Hide primaries attributes Show primaries attributes object
  
  avg number Required
  
  Mean number of shards in an index, counting only shards assigned to selected nodes.
  
  max number Required
  
  Maximum number of shards in an index, counting only shards assigned to selected nodes.
  
  min number Required
  
  Minimum number of shards in an index, counting only shards assigned to selected nodes.
  
  replication object Required
  
  Hide replication attributes Show replication attributes object
  
  avg number Required
  
  Mean number of shards in an index, counting only shards assigned to selected nodes.
  
  max number Required
  
  Maximum number of shards in an index, counting only shards assigned to selected nodes.
  
  min number Required
  
  Minimum number of shards in an index, counting only shards assigned to selected nodes.
  
  shards object Required
  
  Hide shards attributes Show shards attributes object
  
  avg number Required
  
  Mean number of shards in an index, counting only shards assigned to selected nodes.
  
  max number Required
  
  Maximum number of shards in an index, counting only shards assigned to selected nodes.
  
  min number Required
  
  Minimum number of shards in an index, counting only shards assigned to selected nodes.
  
  primaries number
  
  Number of primary shards assigned to selected nodes.
  
  replication number
  
  Ratio of replica shards to primary shards across all selected nodes.
  
  total number
  
  Total number of shards assigned to selected nodes.
  
  store object Required
  
  Hide store attributes Show store attributes object
  
  size number | string
  
  One of:
  ByteSize number ByteSize string
  
  size_in_bytes number Required
  
  Total size, in bytes, of all shards assigned to selected nodes.
  
  reserved number | string
  
  One of:
  ByteSize number ByteSize string
  
  reserved_in_bytes number Required
  
  A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
  
  total_data_set_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  total_data_set_size_in_bytes number
  
  Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.
  
  mappings object Required
  
  Hide mappings attributes Show mappings attributes object
  
  field_types array[object] Required
  
  Contains statistics about field data types used in selected nodes.
  
  Hide field_types attributes Show field_types attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  runtime_field_types array[object]
  
  Contains statistics about runtime field data types used in selected nodes.
  
  Hide runtime_field_types attributes Show runtime_field_types attributes object
  
  chars_max number Required
  
  Maximum number of characters for a single runtime field script.
  
  chars_total number Required
  
  Total number of characters for the scripts that define the current runtime field data type.
  
  count number Required
  
  Number of runtime fields mapped to the field data type in selected nodes.
  
  doc_max number Required
  
  Maximum number of accesses to doc_values for a single runtime field script
  
  doc_total number Required
  
  Total number of accesses to doc_values for the scripts that define the current runtime field data type.
  
  index_count number Required
  
  Number of indices containing a mapping of the runtime field data type in selected nodes.
  
  lang array[string] Required
  
  Script languages used for the runtime fields scripts.
  
  lines_max number Required
  
  Maximum number of lines for a single runtime field script.
  
  lines_total number Required
  
  Total number of lines for the scripts that define the current runtime field data type.
  
  name string Required
  
  scriptless_count number Required
  
  Number of runtime fields that don’t declare a script.
  
  shadowed_count number Required
  
  Number of runtime fields that shadow an indexed field.
  
  source_max number Required
  
  Maximum number of accesses to _source for a single runtime field script.
  
  source_total number Required
  
  Total number of accesses to _source for the scripts that define the current runtime field data type.
  
  total_field_count number
  
  Total number of fields in all non-system indices.
  
  total_deduplicated_field_count number
  
  Total number of fields in all non-system indices, accounting for mapping deduplication.
  
  total_deduplicated_mapping_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  total_deduplicated_mapping_size_in_bytes number
  
  Total size of all mappings, in bytes, after deduplication and compression.
  
  versions array[object]
  
  Contains statistics about analyzers and analyzer components used in selected nodes.
  
  Hide versions attributes Show versions attributes object
  
  index_count number Required
  
  primary_shard_count number Required
  
  total_primary_bytes number Required
  
  version string Required
- nodes object Required
  
  Hide nodes attributes Show nodes attributes object
  
  count object Required
  
  Hide count attributes Show count attributes object
  
  coordinating_only number Required
  
  data number Required
  
  data_cold number Required
  
  data_content number Required
  
  data_frozen number
  
  data_hot number Required
  
  data_warm number Required
  
  ingest number Required
  
  master number Required
  
  ml number Required
  
  remote_cluster_client number Required
  
  total number Required
  
  transform number Required
  
  voting_only number Required
  
  discovery_types object Required
  
  Contains statistics about the discovery types used by selected nodes.
  
  Hide discovery_types attribute Show discovery_types attribute object
  
  * number Additional properties
  
  fs object Required
  
  Hide fs attributes Show fs attributes object
  
  available_in_bytes number Required
  
  Total number of bytes available to JVM in file stores across all selected nodes. Depending on operating system or process-level restrictions, this number may be less than nodes.fs.free_in_byes. This is the actual amount of free disk space the selected Elasticsearch nodes can use.
  
  free_in_bytes number Required
  
  Total number of unallocated bytes in file stores across all selected nodes.
  
  total_in_bytes number Required
  
  Total size, in bytes, of all file stores across all selected nodes.
  
  indexing_pressure object Required
  
  Hide indexing_pressure attribute Show indexing_pressure attribute object
  
  memory object Required
  
  Hide memory attributes Show memory attributes object
  
  current object Required
  
  Hide current attributes Show current attributes object
  
  all_in_bytes number Required
  
  combined_coordinating_and_primary_in_bytes number Required
  
  coordinating_in_bytes number Required
  
  coordinating_rejections number
  
  primary_in_bytes number Required
  
  primary_rejections number
  
  replica_in_bytes number Required
  
  replica_rejections number
  
  limit_in_bytes number Required
  
  total object Required
  
  Hide total attributes Show total attributes object
  
  all_in_bytes number Required
  
  combined_coordinating_and_primary_in_bytes number Required
  
  coordinating_in_bytes number Required
  
  coordinating_rejections number
  
  primary_in_bytes number Required
  
  primary_rejections number
  
  replica_in_bytes number Required
  
  replica_rejections number
  
  ingest object Required
  
  Hide ingest attributes Show ingest attributes object
  
  number_of_pipelines number Required
  
  processor_stats object Required
  
  Hide processor_stats attribute Show processor_stats attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  count number Required
  
  current number Required
  
  failed number Required
  
  time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  jvm object Required
  
  Hide jvm attributes Show jvm attributes object
  
  Time unit for milliseconds
  
  mem object Required
  
  Hide mem attributes Show mem attributes object
  
  heap_max_in_bytes number Required
  
  Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.
  
  heap_used_in_bytes number Required
  
  Memory, in bytes, currently in use by the heap across all selected nodes.
  
  threads number Required
  
  Number of active threads in use by JVM across all selected nodes.
  
  versions array[object] Required
  
  Contains statistics about the JVM versions used by selected nodes.
  
  Hide versions attributes Show versions attributes object
  
  bundled_jdk boolean Required
  
  Always true. All distributions come with a bundled Java Development Kit (JDK).
  
  count number Required
  
  Total number of selected nodes using JVM.
  
  using_bundled_jdk boolean Required
  
  If true, a bundled JDK is in use by JVM.
  
  version string Required
  
  vm_name string Required
  
  Name of the JVM.
  
  vm_vendor string Required
  
  Vendor of the JVM.
  
  vm_version string Required
  
  network_types object Required
  
  Hide network_types attributes Show network_types attributes object
  
  http_types object Required
  
  Contains statistics about the HTTP network types used by selected nodes.
  
  Hide http_types attribute Show http_types attribute object
  
  * number Additional properties
  
  transport_types object Required
  
  Contains statistics about the transport network types used by selected nodes.
  
  Hide transport_types attribute Show transport_types attribute object
  
  * number Additional properties
  
  os object Required
  
  Hide os attributes Show os attributes object
  
  allocated_processors number Required
  
  Number of processors used to calculate thread pool size across all selected nodes. This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system. In both cases, this number will never be larger than 32.
  
  architectures array[object]
  
  Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.
  
  Hide architectures attributes Show architectures attributes object
  
  arch string Required
  
  Name of an architecture used by one or more selected nodes.
  
  count number Required
  
  Number of selected nodes using the architecture.
  
  available_processors number Required
  
  Number of processors available to JVM across all selected nodes.
  
  mem object Required
  
  Hide mem attributes Show mem attributes object
  
  adjusted_total_in_bytes number
  
  Total amount, in bytes, of memory across all selected nodes, but using the value specified using the es.total_memory_bytes system property instead of measured total memory for those nodes where that system property was set.
  
  free_in_bytes number Required
  
  Amount, in bytes, of free physical memory across all selected nodes.
  
  free_percent number Required
  
  Percentage of free physical memory across all selected nodes.
  
  total_in_bytes number Required
  
  Total amount, in bytes, of physical memory across all selected nodes.
  
  used_in_bytes number Required
  
  Amount, in bytes, of physical memory in use across all selected nodes.
  
  used_percent number Required
  
  Percentage of physical memory in use across all selected nodes.
  
  names array[object] Required
  
  Contains statistics about operating systems used by selected nodes.
  
  Hide names attributes Show names attributes object
  
  count number Required
  
  Number of selected nodes using the operating system.
  
  name string Required
  
  pretty_names array[object] Required
  
  Contains statistics about operating systems used by selected nodes.
  
  Hide pretty_names attributes Show pretty_names attributes object
  
  count number Required
  
  Number of selected nodes using the operating system.
  
  pretty_name string Required
  
  packaging_types array[object] Required
  
  Contains statistics about Elasticsearch distributions installed on selected nodes.
  
  Hide packaging_types attributes Show packaging_types attributes object
  
  count number Required
  
  Number of selected nodes using the distribution flavor and file type.
  
  flavor string Required
  
  Type of Elasticsearch distribution. This is always default.
  
  type string Required
  
  File type (such as tar or zip) used for the distribution package.
  
  plugins array[object] Required
  
  Contains statistics about installed plugins and modules by selected nodes. If no plugins or modules are installed, this array is empty.
  
  Hide plugins attributes Show plugins attributes object
  
  classname string Required
  
  description string Required
  
  elasticsearch_version string Required
  
  extended_plugins array[string] Required
  
  has_native_controller boolean Required
  
  java_version string Required
  
  name string Required
  
  version string Required
  
  licensed boolean Required
  
  process object Required
  
  Hide process attributes Show process attributes object
  
  cpu object Required
  
  Hide cpu attribute Show cpu attribute object
  
  percent number Required
  
  Percentage of CPU used across all selected nodes. Returns -1 if not supported.
  
  open_file_descriptors object Required
  
  Hide open_file_descriptors attributes Show open_file_descriptors attributes object
  
  avg number Required
  
  Average number of concurrently open file descriptors. Returns -1 if not supported.
  
  max number Required
  
  Maximum number of concurrently open file descriptors allowed across all selected nodes. Returns -1 if not supported.
  
  min number Required
  
  Minimum number of concurrently open file descriptors across all selected nodes. Returns -1 if not supported.
  
  versions array[string] Required
  
  Array of Elasticsearch versions used on selected nodes.
- status string Required
  
  Values are green, GREEN, yellow, YELLOW, red, or RED.
- timestamp number Required
  
  Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed.

GET /_cluster/stats

curl \
 --request GET 'http://api.example.com/_cluster/stats' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "_nodes": {
    "failures": [
      {
        "type": "string",
        "reason": "string",
        "stack_trace": "string",
        "caused_by": {},
        "root_cause": [
          {}
        ],
        "suppressed": [
          {}
        ]
      }
    ],
    "total": 42.0,
    "successful": 42.0,
    "failed": 42.0
  },
  "cluster_name": "string",
  "cluster_uuid": "string",
  "indices": {
    "analysis": {
      "analyzer_types": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "built_in_analyzers": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "built_in_char_filters": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "built_in_filters": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "built_in_tokenizers": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "char_filter_types": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "filter_types": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "tokenizer_types": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ]
    },
    "completion": {
      "size_in_bytes": 42.0,
      "": 42.0,
      "fields": {
        "additionalProperty1": {
          "size_in_bytes": 42.0
        },
        "additionalProperty2": {
          "size_in_bytes": 42.0
        }
      }
    },
    "count": 42.0,
    "docs": {
      "count": 42.0,
      "deleted": 42.0
    },
    "fielddata": {
      "evictions": 42.0,
      "": 42.0,
      "memory_size_in_bytes": 42.0,
      "fields": {
        "additionalProperty1": {
          "memory_size_in_bytes": 42.0
        },
        "additionalProperty2": {
          "memory_size_in_bytes": 42.0
        }
      }
    },
    "query_cache": {
      "cache_count": 42.0,
      "cache_size": 42.0,
      "evictions": 42.0,
      "hit_count": 42.0,
      "": 42.0,
      "memory_size_in_bytes": 42.0,
      "miss_count": 42.0,
      "total_count": 42.0
    },
    "segments": {
      "count": 42.0,
      "": 42.0,
      "doc_values_memory_in_bytes": 42.0,
      "file_sizes": {
        "additionalProperty1": {
          "description": "string",
          "size_in_bytes": 42.0,
          "min_size_in_bytes": 42.0,
          "max_size_in_bytes": 42.0,
          "average_size_in_bytes": 42.0,
          "count": 42.0
        },
        "additionalProperty2": {
          "description": "string",
          "size_in_bytes": 42.0,
          "min_size_in_bytes": 42.0,
          "max_size_in_bytes": 42.0,
          "average_size_in_bytes": 42.0,
          "count": 42.0
        }
      },
      "fixed_bit_set_memory_in_bytes": 42.0,
      "index_writer_max_memory_in_bytes": 42.0,
      "index_writer_memory_in_bytes": 42.0,
      "max_unsafe_auto_id_timestamp": 42.0,
      "memory_in_bytes": 42.0,
      "norms_memory_in_bytes": 42.0,
      "points_memory_in_bytes": 42.0,
      "stored_fields_memory_in_bytes": 42.0,
      "terms_memory_in_bytes": 42.0,
      "term_vectors_memory_in_bytes": 42.0,
      "version_map_memory_in_bytes": 42.0
    },
    "shards": {
      "index": {
        "primaries": {
          "avg": 42.0,
          "max": 42.0,
          "min": 42.0
        },
        "replication": {
          "avg": 42.0,
          "max": 42.0,
          "min": 42.0
        },
        "shards": {
          "avg": 42.0,
          "max": 42.0,
          "min": 42.0
        }
      },
      "primaries": 42.0,
      "replication": 42.0,
      "total": 42.0
    },
    "store": {
      "": 42.0,
      "size_in_bytes": 42.0,
      "reserved_in_bytes": 42.0,
      "total_data_set_size_in_bytes": 42.0
    },
    "mappings": {
      "field_types": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "runtime_field_types": [
        {
          "chars_max": 42.0,
          "chars_total": 42.0,
          "count": 42.0,
          "doc_max": 42.0,
          "doc_total": 42.0,
          "index_count": 42.0,
          "lang": [
            "string"
          ],
          "lines_max": 42.0,
          "lines_total": 42.0,
          "name": "string",
          "scriptless_count": 42.0,
          "shadowed_count": 42.0,
          "source_max": 42.0,
          "source_total": 42.0
        }
      ],
      "total_field_count": 42.0,
      "total_deduplicated_field_count": 42.0,
      "": 42.0,
      "total_deduplicated_mapping_size_in_bytes": 42.0
    },
    "versions": [
      {
        "index_count": 42.0,
        "primary_shard_count": 42.0,
        "total_primary_bytes": 42.0,
        "version": "string"
      }
    ]
  },
  "nodes": {
    "count": {
      "coordinating_only": 42.0,
      "data": 42.0,
      "data_cold": 42.0,
      "data_content": 42.0,
      "data_frozen": 42.0,
      "data_hot": 42.0,
      "data_warm": 42.0,
      "ingest": 42.0,
      "master": 42.0,
      "ml": 42.0,
      "remote_cluster_client": 42.0,
      "total": 42.0,
      "transform": 42.0,
      "voting_only": 42.0
    },
    "discovery_types": {
      "additionalProperty1": 42.0,
      "additionalProperty2": 42.0
    },
    "fs": {
      "available_in_bytes": 42.0,
      "free_in_bytes": 42.0,
      "total_in_bytes": 42.0
    },
    "indexing_pressure": {
      "memory": {
        "current": {
          "all_in_bytes": 42.0,
          "combined_coordinating_and_primary_in_bytes": 42.0,
          "coordinating_in_bytes": 42.0,
          "coordinating_rejections": 42.0,
          "primary_in_bytes": 42.0,
          "primary_rejections": 42.0,
          "replica_in_bytes": 42.0,
          "replica_rejections": 42.0
        },
        "limit_in_bytes": 42.0,
        "total": {
          "all_in_bytes": 42.0,
          "combined_coordinating_and_primary_in_bytes": 42.0,
          "coordinating_in_bytes": 42.0,
          "coordinating_rejections": 42.0,
          "primary_in_bytes": 42.0,
          "primary_rejections": 42.0,
          "replica_in_bytes": 42.0,
          "replica_rejections": 42.0
        }
      }
    },
    "ingest": {
      "number_of_pipelines": 42.0,
      "processor_stats": {
        "additionalProperty1": {
          "count": 42.0,
          "current": 42.0,
          "failed": 42.0,
          "time": "string"
        },
        "additionalProperty2": {
          "count": 42.0,
          "current": 42.0,
          "failed": 42.0,
          "time": "string"
        }
      }
    },
    "jvm": {
      "": 42.0,
      "mem": {
        "heap_max_in_bytes": 42.0,
        "heap_used_in_bytes": 42.0
      },
      "threads": 42.0,
      "versions": [
        {
          "bundled_jdk": true,
          "count": 42.0,
          "using_bundled_jdk": true,
          "version": "string",
          "vm_name": "string",
          "vm_vendor": "string",
          "vm_version": "string"
        }
      ]
    },
    "network_types": {
      "http_types": {
        "additionalProperty1": 42.0,
        "additionalProperty2": 42.0
      },
      "transport_types": {
        "additionalProperty1": 42.0,
        "additionalProperty2": 42.0
      }
    },
    "os": {
      "allocated_processors": 42.0,
      "architectures": [
        {
          "arch": "string",
          "count": 42.0
        }
      ],
      "available_processors": 42.0,
      "mem": {
        "adjusted_total_in_bytes": 42.0,
        "free_in_bytes": 42.0,
        "free_percent": 42.0,
        "total_in_bytes": 42.0,
        "used_in_bytes": 42.0,
        "used_percent": 42.0
      },
      "names": [
        {
          "count": 42.0,
          "name": "string"
        }
      ],
      "pretty_names": [
        {
          "count": 42.0,
          "pretty_name": "string"
        }
      ]
    },
    "packaging_types": [
      {
        "count": 42.0,
        "flavor": "string",
        "type": "string"
      }
    ],
    "plugins": [
      {
        "classname": "string",
        "description": "string",
        "elasticsearch_version": "string",
        "extended_plugins": [
          "string"
        ],
        "has_native_controller": true,
        "java_version": "string",
        "name": "string",
        "version": "string",
        "licensed": true
      }
    ],
    "process": {
      "cpu": {
        "percent": 42.0
      },
      "open_file_descriptors": {
        "avg": 42.0,
        "max": 42.0,
        "min": 42.0
      }
    },
    "versions": [
      "string"
    ]
  },
  "status": "green",
  "timestamp": 42.0
}

Get cluster statistics Added in 1.3.0

GET /_cluster/stats/nodes/{node_id}

Api key auth Basic auth Bearer auth

Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).

Path parameters

node_id string | array[string] Required

Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.

Query parameters

include_remotes boolean

Include remote cluster data into the response
timeout string

Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout.

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string
  
  A human-readable explanation of the error, in English.
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  root_cause array[object]
  
  suppressed array[object]
  
  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
- cluster_uuid string Required
- indices object Required
  
  Hide indices attributes Show indices attributes object
  
  analysis object Required
  
  Hide analysis attributes Show analysis attributes object
  
  analyzer_types array[object] Required
  
  Contains statistics about analyzer types used in selected nodes.
  
  Hide analyzer_types attributes Show analyzer_types attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  built_in_analyzers array[object] Required
  
  Contains statistics about built-in analyzers used in selected nodes.
  
  Hide built_in_analyzers attributes Show built_in_analyzers attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  built_in_char_filters array[object] Required
  
  Contains statistics about built-in character filters used in selected nodes.
  
  Hide built_in_char_filters attributes Show built_in_char_filters attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  built_in_filters array[object] Required
  
  Contains statistics about built-in token filters used in selected nodes.
  
  Hide built_in_filters attributes Show built_in_filters attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  built_in_tokenizers array[object] Required
  
  Contains statistics about built-in tokenizers used in selected nodes.
  
  Hide built_in_tokenizers attributes Show built_in_tokenizers attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  char_filter_types array[object] Required
  
  Contains statistics about character filter types used in selected nodes.
  
  Hide char_filter_types attributes Show char_filter_types attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  filter_types array[object] Required
  
  Contains statistics about token filter types used in selected nodes.
  
  Hide filter_types attributes Show filter_types attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  tokenizer_types array[object] Required
  
  Contains statistics about tokenizer types used in selected nodes.
  
  Hide tokenizer_types attributes Show tokenizer_types attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  completion object Required
  
  Hide completion attributes Show completion attributes object
  
  size_in_bytes number Required
  
  Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
  
  size number | string
  
  One of:
  ByteSize number ByteSize string
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  size
  
  size_in_bytes number Required
  
  count number Required
  
  Total number of indices with shards assigned to selected nodes.
  
  docs object Required
  
  Hide docs attributes Show docs attributes object
  
  count number Required
  
  Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.
  
  deleted number
  
  Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
  
  fielddata object Required
  
  Hide fielddata attributes Show fielddata attributes object
  
  evictions number
  
  memory_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_size_in_bytes number Required
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  memory_size
  
  memory_size_in_bytes number Required
  
  query_cache object Required
  
  Hide query_cache attributes Show query_cache attributes object
  
  cache_count number Required
  
  Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.
  
  cache_size number Required
  
  Total number of entries currently in the query cache across all shards assigned to selected nodes.
  
  evictions number Required
  
  Total number of query cache evictions across all shards assigned to selected nodes.
  
  hit_count number Required
  
  Total count of query cache hits across all shards assigned to selected nodes.
  
  memory_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_size_in_bytes number Required
  
  Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
  
  miss_count number Required
  
  Total count of query cache misses across all shards assigned to selected nodes.
  
  total_count number Required
  
  Total count of hits and misses in the query cache across all shards assigned to selected nodes.
  
  segments object Required
  
  Hide segments attributes Show segments attributes object
  
  count number Required
  
  Total number of segments across all shards assigned to selected nodes.
  
  doc_values_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  doc_values_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
  
  file_sizes object Required
  
  This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
  
  Hide file_sizes attribute Show file_sizes attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  description string Required
  
  size_in_bytes number Required
  
  min_size_in_bytes number
  
  max_size_in_bytes number
  
  average_size_in_bytes number
  
  count number
  
  fixed_bit_set number | string
  
  One of:
  ByteSize number ByteSize string
  
  fixed_bit_set_memory_in_bytes number Required
  
  Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
  
  index_writer_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  index_writer_max_memory_in_bytes number
  
  index_writer_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
  
  max_unsafe_auto_id_timestamp number Required
  
  Unix timestamp, in milliseconds, of the most recently retried indexing request.
  
  memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
  
  norms_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  norms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
  
  points_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  points_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
  
  stored_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  stored_fields_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
  
  terms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
  
  terms_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  term_vectory_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  term_vectors_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
  
  version_map_memory number | string
  
  One of:
  ByteSize number ByteSize string
  
  version_map_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
  
  shards object Required
  
  Hide shards attributes Show shards attributes object
  
  index object
  
  Hide index attributes Show index attributes object
  
  primaries object Required
  
  Hide primaries attributes Show primaries attributes object
  
  avg number Required
  
  Mean number of shards in an index, counting only shards assigned to selected nodes.
  
  max number Required
  
  Maximum number of shards in an index, counting only shards assigned to selected nodes.
  
  min number Required
  
  Minimum number of shards in an index, counting only shards assigned to selected nodes.
  
  replication object Required
  
  Hide replication attributes Show replication attributes object
  
  avg number Required
  
  Mean number of shards in an index, counting only shards assigned to selected nodes.
  
  max number Required
  
  Maximum number of shards in an index, counting only shards assigned to selected nodes.
  
  min number Required
  
  Minimum number of shards in an index, counting only shards assigned to selected nodes.
  
  shards object Required
  
  Hide shards attributes Show shards attributes object
  
  avg number Required
  
  Mean number of shards in an index, counting only shards assigned to selected nodes.
  
  max number Required
  
  Maximum number of shards in an index, counting only shards assigned to selected nodes.
  
  min number Required
  
  Minimum number of shards in an index, counting only shards assigned to selected nodes.
  
  primaries number
  
  Number of primary shards assigned to selected nodes.
  
  replication number
  
  Ratio of replica shards to primary shards across all selected nodes.
  
  total number
  
  Total number of shards assigned to selected nodes.
  
  store object Required
  
  Hide store attributes Show store attributes object
  
  size number | string
  
  One of:
  ByteSize number ByteSize string
  
  size_in_bytes number Required
  
  Total size, in bytes, of all shards assigned to selected nodes.
  
  reserved number | string
  
  One of:
  ByteSize number ByteSize string
  
  reserved_in_bytes number Required
  
  A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
  
  total_data_set_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  total_data_set_size_in_bytes number
  
  Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.
  
  mappings object Required
  
  Hide mappings attributes Show mappings attributes object
  
  field_types array[object] Required
  
  Contains statistics about field data types used in selected nodes.
  
  Hide field_types attributes Show field_types attributes object
  
  name string Required
  
  count number Required
  
  The number of occurrences of the field type in selected nodes.
  
  index_count number Required
  
  The number of indices containing the field type in selected nodes.
  
  indexed_vector_count number
  
  For dense_vector field types, number of indexed vector types in selected nodes.
  
  indexed_vector_dim_max number
  
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  
  indexed_vector_dim_min number
  
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  
  script_count number
  
  The number of fields that declare a script.
  
  runtime_field_types array[object]
  
  Contains statistics about runtime field data types used in selected nodes.
  
  Hide runtime_field_types attributes Show runtime_field_types attributes object
  
  chars_max number Required
  
  Maximum number of characters for a single runtime field script.
  
  chars_total number Required
  
  Total number of characters for the scripts that define the current runtime field data type.
  
  count number Required
  
  Number of runtime fields mapped to the field data type in selected nodes.
  
  doc_max number Required
  
  Maximum number of accesses to doc_values for a single runtime field script
  
  doc_total number Required
  
  Total number of accesses to doc_values for the scripts that define the current runtime field data type.
  
  index_count number Required
  
  Number of indices containing a mapping of the runtime field data type in selected nodes.
  
  lang array[string] Required
  
  Script languages used for the runtime fields scripts.
  
  lines_max number Required
  
  Maximum number of lines for a single runtime field script.
  
  lines_total number Required
  
  Total number of lines for the scripts that define the current runtime field data type.
  
  name string Required
  
  scriptless_count number Required
  
  Number of runtime fields that don’t declare a script.
  
  shadowed_count number Required
  
  Number of runtime fields that shadow an indexed field.
  
  source_max number Required
  
  Maximum number of accesses to _source for a single runtime field script.
  
  source_total number Required
  
  Total number of accesses to _source for the scripts that define the current runtime field data type.
  
  total_field_count number
  
  Total number of fields in all non-system indices.
  
  total_deduplicated_field_count number
  
  Total number of fields in all non-system indices, accounting for mapping deduplication.
  
  total_deduplicated_mapping_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  total_deduplicated_mapping_size_in_bytes number
  
  Total size of all mappings, in bytes, after deduplication and compression.
  
  versions array[object]
  
  Contains statistics about analyzers and analyzer components used in selected nodes.
  
  Hide versions attributes Show versions attributes object
  
  index_count number Required
  
  primary_shard_count number Required
  
  total_primary_bytes number Required
  
  version string Required
- nodes object Required
  
  Hide nodes attributes Show nodes attributes object
  
  count object Required
  
  Hide count attributes Show count attributes object
  
  coordinating_only number Required
  
  data number Required
  
  data_cold number Required
  
  data_content number Required
  
  data_frozen number
  
  data_hot number Required
  
  data_warm number Required
  
  ingest number Required
  
  master number Required
  
  ml number Required
  
  remote_cluster_client number Required
  
  total number Required
  
  transform number Required
  
  voting_only number Required
  
  discovery_types object Required
  
  Contains statistics about the discovery types used by selected nodes.
  
  Hide discovery_types attribute Show discovery_types attribute object
  
  * number Additional properties
  
  fs object Required
  
  Hide fs attributes Show fs attributes object
  
  available_in_bytes number Required
  
  Total number of bytes available to JVM in file stores across all selected nodes. Depending on operating system or process-level restrictions, this number may be less than nodes.fs.free_in_byes. This is the actual amount of free disk space the selected Elasticsearch nodes can use.
  
  free_in_bytes number Required
  
  Total number of unallocated bytes in file stores across all selected nodes.
  
  total_in_bytes number Required
  
  Total size, in bytes, of all file stores across all selected nodes.
  
  indexing_pressure object Required
  
  Hide indexing_pressure attribute Show indexing_pressure attribute object
  
  memory object Required
  
  Hide memory attributes Show memory attributes object
  
  current object Required
  
  Hide current attributes Show current attributes object
  
  all_in_bytes number Required
  
  combined_coordinating_and_primary_in_bytes number Required
  
  coordinating_in_bytes number Required
  
  coordinating_rejections number
  
  primary_in_bytes number Required
  
  primary_rejections number
  
  replica_in_bytes number Required
  
  replica_rejections number
  
  limit_in_bytes number Required
  
  total object Required
  
  Hide total attributes Show total attributes object
  
  all_in_bytes number Required
  
  combined_coordinating_and_primary_in_bytes number Required
  
  coordinating_in_bytes number Required
  
  coordinating_rejections number
  
  primary_in_bytes number Required
  
  primary_rejections number
  
  replica_in_bytes number Required
  
  replica_rejections number
  
  ingest object Required
  
  Hide ingest attributes Show ingest attributes object
  
  number_of_pipelines number Required
  
  processor_stats object Required
  
  Hide processor_stats attribute Show processor_stats attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  count number Required
  
  current number Required
  
  failed number Required
  
  time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  jvm object Required
  
  Hide jvm attributes Show jvm attributes object
  
  Time unit for milliseconds
  
  mem object Required
  
  Hide mem attributes Show mem attributes object
  
  heap_max_in_bytes number Required
  
  Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.
  
  heap_used_in_bytes number Required
  
  Memory, in bytes, currently in use by the heap across all selected nodes.
  
  threads number Required
  
  Number of active threads in use by JVM across all selected nodes.
  
  versions array[object] Required
  
  Contains statistics about the JVM versions used by selected nodes.
  
  Hide versions attributes Show versions attributes object
  
  bundled_jdk boolean Required
  
  Always true. All distributions come with a bundled Java Development Kit (JDK).
  
  count number Required
  
  Total number of selected nodes using JVM.
  
  using_bundled_jdk boolean Required
  
  If true, a bundled JDK is in use by JVM.
  
  version string Required
  
  vm_name string Required
  
  Name of the JVM.
  
  vm_vendor string Required
  
  Vendor of the JVM.
  
  vm_version string Required
  
  network_types object Required
  
  Hide network_types attributes Show network_types attributes object
  
  http_types object Required
  
  Contains statistics about the HTTP network types used by selected nodes.
  
  Hide http_types attribute Show http_types attribute object
  
  * number Additional properties
  
  transport_types object Required
  
  Contains statistics about the transport network types used by selected nodes.
  
  Hide transport_types attribute Show transport_types attribute object
  
  * number Additional properties
  
  os object Required
  
  Hide os attributes Show os attributes object
  
  allocated_processors number Required
  
  Number of processors used to calculate thread pool size across all selected nodes. This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system. In both cases, this number will never be larger than 32.
  
  architectures array[object]
  
  Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.
  
  Hide architectures attributes Show architectures attributes object
  
  arch string Required
  
  Name of an architecture used by one or more selected nodes.
  
  count number Required
  
  Number of selected nodes using the architecture.
  
  available_processors number Required
  
  Number of processors available to JVM across all selected nodes.
  
  mem object Required
  
  Hide mem attributes Show mem attributes object
  
  adjusted_total_in_bytes number
  
  Total amount, in bytes, of memory across all selected nodes, but using the value specified using the es.total_memory_bytes system property instead of measured total memory for those nodes where that system property was set.
  
  free_in_bytes number Required
  
  Amount, in bytes, of free physical memory across all selected nodes.
  
  free_percent number Required
  
  Percentage of free physical memory across all selected nodes.
  
  total_in_bytes number Required
  
  Total amount, in bytes, of physical memory across all selected nodes.
  
  used_in_bytes number Required
  
  Amount, in bytes, of physical memory in use across all selected nodes.
  
  used_percent number Required
  
  Percentage of physical memory in use across all selected nodes.
  
  names array[object] Required
  
  Contains statistics about operating systems used by selected nodes.
  
  Hide names attributes Show names attributes object
  
  count number Required
  
  Number of selected nodes using the operating system.
  
  name string Required
  
  pretty_names array[object] Required
  
  Contains statistics about operating systems used by selected nodes.
  
  Hide pretty_names attributes Show pretty_names attributes object
  
  count number Required
  
  Number of selected nodes using the operating system.
  
  pretty_name string Required
  
  packaging_types array[object] Required
  
  Contains statistics about Elasticsearch distributions installed on selected nodes.
  
  Hide packaging_types attributes Show packaging_types attributes object
  
  count number Required
  
  Number of selected nodes using the distribution flavor and file type.
  
  flavor string Required
  
  Type of Elasticsearch distribution. This is always default.
  
  type string Required
  
  File type (such as tar or zip) used for the distribution package.
  
  plugins array[object] Required
  
  Contains statistics about installed plugins and modules by selected nodes. If no plugins or modules are installed, this array is empty.
  
  Hide plugins attributes Show plugins attributes object
  
  classname string Required
  
  description string Required
  
  elasticsearch_version string Required
  
  extended_plugins array[string] Required
  
  has_native_controller boolean Required
  
  java_version string Required
  
  name string Required
  
  version string Required
  
  licensed boolean Required
  
  process object Required
  
  Hide process attributes Show process attributes object
  
  cpu object Required
  
  Hide cpu attribute Show cpu attribute object
  
  percent number Required
  
  Percentage of CPU used across all selected nodes. Returns -1 if not supported.
  
  open_file_descriptors object Required
  
  Hide open_file_descriptors attributes Show open_file_descriptors attributes object
  
  avg number Required
  
  Average number of concurrently open file descriptors. Returns -1 if not supported.
  
  max number Required
  
  Maximum number of concurrently open file descriptors allowed across all selected nodes. Returns -1 if not supported.
  
  min number Required
  
  Minimum number of concurrently open file descriptors across all selected nodes. Returns -1 if not supported.
  
  versions array[string] Required
  
  Array of Elasticsearch versions used on selected nodes.
- status string Required
  
  Values are green, GREEN, yellow, YELLOW, red, or RED.
- timestamp number Required
  
  Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed.

GET /_cluster/stats/nodes/{node_id}

curl \
 --request GET 'http://api.example.com/_cluster/stats/nodes/{node_id}' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "_nodes": {
    "failures": [
      {
        "type": "string",
        "reason": "string",
        "stack_trace": "string",
        "caused_by": {},
        "root_cause": [
          {}
        ],
        "suppressed": [
          {}
        ]
      }
    ],
    "total": 42.0,
    "successful": 42.0,
    "failed": 42.0
  },
  "cluster_name": "string",
  "cluster_uuid": "string",
  "indices": {
    "analysis": {
      "analyzer_types": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "built_in_analyzers": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "built_in_char_filters": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "built_in_filters": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "built_in_tokenizers": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "char_filter_types": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "filter_types": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "tokenizer_types": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ]
    },
    "completion": {
      "size_in_bytes": 42.0,
      "": 42.0,
      "fields": {
        "additionalProperty1": {
          "size_in_bytes": 42.0
        },
        "additionalProperty2": {
          "size_in_bytes": 42.0
        }
      }
    },
    "count": 42.0,
    "docs": {
      "count": 42.0,
      "deleted": 42.0
    },
    "fielddata": {
      "evictions": 42.0,
      "": 42.0,
      "memory_size_in_bytes": 42.0,
      "fields": {
        "additionalProperty1": {
          "memory_size_in_bytes": 42.0
        },
        "additionalProperty2": {
          "memory_size_in_bytes": 42.0
        }
      }
    },
    "query_cache": {
      "cache_count": 42.0,
      "cache_size": 42.0,
      "evictions": 42.0,
      "hit_count": 42.0,
      "": 42.0,
      "memory_size_in_bytes": 42.0,
      "miss_count": 42.0,
      "total_count": 42.0
    },
    "segments": {
      "count": 42.0,
      "": 42.0,
      "doc_values_memory_in_bytes": 42.0,
      "file_sizes": {
        "additionalProperty1": {
          "description": "string",
          "size_in_bytes": 42.0,
          "min_size_in_bytes": 42.0,
          "max_size_in_bytes": 42.0,
          "average_size_in_bytes": 42.0,
          "count": 42.0
        },
        "additionalProperty2": {
          "description": "string",
          "size_in_bytes": 42.0,
          "min_size_in_bytes": 42.0,
          "max_size_in_bytes": 42.0,
          "average_size_in_bytes": 42.0,
          "count": 42.0
        }
      },
      "fixed_bit_set_memory_in_bytes": 42.0,
      "index_writer_max_memory_in_bytes": 42.0,
      "index_writer_memory_in_bytes": 42.0,
      "max_unsafe_auto_id_timestamp": 42.0,
      "memory_in_bytes": 42.0,
      "norms_memory_in_bytes": 42.0,
      "points_memory_in_bytes": 42.0,
      "stored_fields_memory_in_bytes": 42.0,
      "terms_memory_in_bytes": 42.0,
      "term_vectors_memory_in_bytes": 42.0,
      "version_map_memory_in_bytes": 42.0
    },
    "shards": {
      "index": {
        "primaries": {
          "avg": 42.0,
          "max": 42.0,
          "min": 42.0
        },
        "replication": {
          "avg": 42.0,
          "max": 42.0,
          "min": 42.0
        },
        "shards": {
          "avg": 42.0,
          "max": 42.0,
          "min": 42.0
        }
      },
      "primaries": 42.0,
      "replication": 42.0,
      "total": 42.0
    },
    "store": {
      "": 42.0,
      "size_in_bytes": 42.0,
      "reserved_in_bytes": 42.0,
      "total_data_set_size_in_bytes": 42.0
    },
    "mappings": {
      "field_types": [
        {
          "name": "string",
          "count": 42.0,
          "index_count": 42.0,
          "indexed_vector_count": 42.0,
          "indexed_vector_dim_max": 42.0,
          "indexed_vector_dim_min": 42.0,
          "script_count": 42.0
        }
      ],
      "runtime_field_types": [
        {
          "chars_max": 42.0,
          "chars_total": 42.0,
          "count": 42.0,
          "doc_max": 42.0,
          "doc_total": 42.0,
          "index_count": 42.0,
          "lang": [
            "string"
          ],
          "lines_max": 42.0,
          "lines_total": 42.0,
          "name": "string",
          "scriptless_count": 42.0,
          "shadowed_count": 42.0,
          "source_max": 42.0,
          "source_total": 42.0
        }
      ],
      "total_field_count": 42.0,
      "total_deduplicated_field_count": 42.0,
      "": 42.0,
      "total_deduplicated_mapping_size_in_bytes": 42.0
    },
    "versions": [
      {
        "index_count": 42.0,
        "primary_shard_count": 42.0,
        "total_primary_bytes": 42.0,
        "version": "string"
      }
    ]
  },
  "nodes": {
    "count": {
      "coordinating_only": 42.0,
      "data": 42.0,
      "data_cold": 42.0,
      "data_content": 42.0,
      "data_frozen": 42.0,
      "data_hot": 42.0,
      "data_warm": 42.0,
      "ingest": 42.0,
      "master": 42.0,
      "ml": 42.0,
      "remote_cluster_client": 42.0,
      "total": 42.0,
      "transform": 42.0,
      "voting_only": 42.0
    },
    "discovery_types": {
      "additionalProperty1": 42.0,
      "additionalProperty2": 42.0
    },
    "fs": {
      "available_in_bytes": 42.0,
      "free_in_bytes": 42.0,
      "total_in_bytes": 42.0
    },
    "indexing_pressure": {
      "memory": {
        "current": {
          "all_in_bytes": 42.0,
          "combined_coordinating_and_primary_in_bytes": 42.0,
          "coordinating_in_bytes": 42.0,
          "coordinating_rejections": 42.0,
          "primary_in_bytes": 42.0,
          "primary_rejections": 42.0,
          "replica_in_bytes": 42.0,
          "replica_rejections": 42.0
        },
        "limit_in_bytes": 42.0,
        "total": {
          "all_in_bytes": 42.0,
          "combined_coordinating_and_primary_in_bytes": 42.0,
          "coordinating_in_bytes": 42.0,
          "coordinating_rejections": 42.0,
          "primary_in_bytes": 42.0,
          "primary_rejections": 42.0,
          "replica_in_bytes": 42.0,
          "replica_rejections": 42.0
        }
      }
    },
    "ingest": {
      "number_of_pipelines": 42.0,
      "processor_stats": {
        "additionalProperty1": {
          "count": 42.0,
          "current": 42.0,
          "failed": 42.0,
          "time": "string"
        },
        "additionalProperty2": {
          "count": 42.0,
          "current": 42.0,
          "failed": 42.0,
          "time": "string"
        }
      }
    },
    "jvm": {
      "": 42.0,
      "mem": {
        "heap_max_in_bytes": 42.0,
        "heap_used_in_bytes": 42.0
      },
      "threads": 42.0,
      "versions": [
        {
          "bundled_jdk": true,
          "count": 42.0,
          "using_bundled_jdk": true,
          "version": "string",
          "vm_name": "string",
          "vm_vendor": "string",
          "vm_version": "string"
        }
      ]
    },
    "network_types": {
      "http_types": {
        "additionalProperty1": 42.0,
        "additionalProperty2": 42.0
      },
      "transport_types": {
        "additionalProperty1": 42.0,
        "additionalProperty2": 42.0
      }
    },
    "os": {
      "allocated_processors": 42.0,
      "architectures": [
        {
          "arch": "string",
          "count": 42.0
        }
      ],
      "available_processors": 42.0,
      "mem": {
        "adjusted_total_in_bytes": 42.0,
        "free_in_bytes": 42.0,
        "free_percent": 42.0,
        "total_in_bytes": 42.0,
        "used_in_bytes": 42.0,
        "used_percent": 42.0
      },
      "names": [
        {
          "count": 42.0,
          "name": "string"
        }
      ],
      "pretty_names": [
        {
          "count": 42.0,
          "pretty_name": "string"
        }
      ]
    },
    "packaging_types": [
      {
        "count": 42.0,
        "flavor": "string",
        "type": "string"
      }
    ],
    "plugins": [
      {
        "classname": "string",
        "description": "string",
        "elasticsearch_version": "string",
        "extended_plugins": [
          "string"
        ],
        "has_native_controller": true,
        "java_version": "string",
        "name": "string",
        "version": "string",
        "licensed": true
      }
    ],
    "process": {
      "cpu": {
        "percent": 42.0
      },
      "open_file_descriptors": {
        "avg": 42.0,
        "max": 42.0,
        "min": 42.0
      }
    },
    "versions": [
      "string"
    ]
  },
  "status": "green",
  "timestamp": 42.0
}

Clear the archived repositories metering Technical preview

DELETE /_nodes/{node_id}/_repositories_metering/{max_archive_version}

Api key auth Basic auth Bearer auth

Clear the archived repositories metering information in the cluster.

Path parameters

node_id string | array[string] Required

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

Specifies the maximum archive_version to be cleared from the archive.

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string
  
  A human-readable explanation of the error, in English.
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  root_cause array[object]
  
  suppressed array[object]
  
  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 object Required
  
  Contains repositories metering information for the nodes selected by the request.
  
  Hide nodes attribute Show nodes attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  repository_name string Required
  
  repository_type string Required
  
  Repository type.
  
  repository_location object Required
  
  Hide repository_location attributes Show repository_location attributes object
  
  base_path string Required
  
  container string
  
  Container name (Azure)
  
  bucket string
  
  Bucket name (GCP, S3)
  
  repository_ephemeral_id string Required
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  archived boolean Required
  
  A flag that tells whether or not this object has been archived. When a repository is closed or updated the repository metering information is archived and kept for a certain period of time. This allows retrieving the repository metering information of previous repository instantiations.
  
  cluster_version number
  
  request_counts object Required
  
  Hide request_counts attributes Show request_counts attributes object
  
  GetBlobProperties number
  
  Number of Get Blob Properties requests (Azure)
  
  GetBlob number
  
  Number of Get Blob requests (Azure)
  
  ListBlobs number
  
  Number of List Blobs requests (Azure)
  
  PutBlob number
  
  Number of Put Blob requests (Azure)
  
  PutBlock number
  
  Number of Put Block (Azure)
  
  PutBlockList number
  
  Number of Put Block List requests
  
  GetObject number
  
  Number of get object requests (GCP, S3)
  
  ListObjects number
  
  Number of list objects requests (GCP, S3)
  
  InsertObject number
  
  Number of insert object requests, including simple, multipart and resumable uploads. Resumable uploads can perform multiple http requests to insert a single object but they are considered as a single request since they are billed as an individual operation. (GCP)
  
  PutObject number
  
  Number of PutObject requests (S3)
  
  PutMultipartObject number
  
  Number of Multipart requests, including CreateMultipartUpload, UploadPart and CompleteMultipartUpload requests (S3)

DELETE /_nodes/{node_id}/_repositories_metering/{max_archive_version}

curl \
 --request DELETE 'http://api.example.com/_nodes/{node_id}/_repositories_metering/{max_archive_version}' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "_nodes": {
    "failures": [
      {
        "type": "string",
        "reason": "string",
        "stack_trace": "string",
        "caused_by": {},
        "root_cause": [
          {}
        ],
        "suppressed": [
          {}
        ]
      }
    ],
    "total": 42.0,
    "successful": 42.0,
    "failed": 42.0
  },
  "cluster_name": "string",
  "nodes": {
    "additionalProperty1": {
      "repository_name": "string",
      "repository_type": "string",
      "repository_location": {
        "base_path": "string",
        "container": "string",
        "bucket": "string"
      },
      "repository_ephemeral_id": "string",
      "": 42.0,
      "archived": true,
      "cluster_version": 42.0,
      "request_counts": {
        "GetBlobProperties": 42.0,
        "GetBlob": 42.0,
        "ListBlobs": 42.0,
        "PutBlob": 42.0,
        "PutBlock": 42.0,
        "PutBlockList": 42.0,
        "GetObject": 42.0,
        "ListObjects": 42.0,
        "InsertObject": 42.0,
        "PutObject": 42.0,
        "PutMultipartObject": 42.0
      }
    },
    "additionalProperty2": {
      "repository_name": "string",
      "repository_type": "string",
      "repository_location": {
        "base_path": "string",
        "container": "string",
        "bucket": "string"
      },
      "repository_ephemeral_id": "string",
      "": 42.0,
      "archived": true,
      "cluster_version": 42.0,
      "request_counts": {
        "GetBlobProperties": 42.0,
        "GetBlob": 42.0,
        "ListBlobs": 42.0,
        "PutBlob": 42.0,
        "PutBlock": 42.0,
        "PutBlockList": 42.0,
        "GetObject": 42.0,
        "ListObjects": 42.0,
        "InsertObject": 42.0,
        "PutObject": 42.0,
        "PutMultipartObject": 42.0
      }
    }
  }
}

Get node information Added in 1.3.0

GET /_nodes/{node_id}

Api key auth Basic auth Bearer auth

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

Path parameters

node_id string | array[string] Required

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

Query parameters

flat_settings boolean

If true, returns settings in flat format.
timeout string

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

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string
  
  A human-readable explanation of the error, in English.
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  root_cause array[object]
  
  suppressed array[object]
  
  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 object Required
  
  Hide nodes attribute Show nodes attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  attributes object Required
  
  Hide attributes attribute Show attributes attribute object
  
  * string Additional properties
  
  build_flavor string Required
  
  build_hash string Required
  
  Short hash of the last git commit in this release.
  
  build_type string Required
  
  host string Required
  
  http object
  
  Hide http attributes Show http attributes object
  
  bound_address array[string] Required
  
  max_content_length number | string
  
  One of:
  ByteSize number ByteSize string
  
  max_content_length_in_bytes number Required
  
  publish_address string Required
  
  ip string Required
  
  jvm object
  
  Hide jvm attributes Show jvm attributes object
  
  gc_collectors array[string] Required
  
  mem object Required
  
  Hide mem attributes Show mem attributes object
  
  direct_max
  
  direct_max_in_bytes number Required
  
  heap_init
  
  heap_init_in_bytes number Required
  
  heap_max
  
  heap_max_in_bytes number Required
  
  non_heap_init
  
  non_heap_init_in_bytes number Required
  
  non_heap_max
  
  non_heap_max_in_bytes number Required
  
  memory_pools array[string] Required
  
  pid number Required
  
  Time unit for milliseconds
  
  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
  
  One of:
  boolean-1 boolean string-2 string
  
  input_arguments array[string] Required
  
  name string Required
  
  network object
  
  Hide network attributes Show network attributes object
  
  primary_interface object Required
  
  Hide primary_interface attributes Show primary_interface attributes object
  
  address string Required
  
  mac_address string Required
  
  name string Required
  
  refresh_interval number Required
  
  os object
  
  Hide os attributes Show os attributes 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
  
  pretty_name string Required
  
  Time unit for milliseconds
  
  version string Required
  
  cpu object
  
  Hide cpu attributes Show cpu attributes 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
  
  Hide mem attributes Show mem attributes object
  
  total string Required
  
  total_in_bytes number Required
  
  swap object
  
  Hide swap attributes Show swap attributes object
  
  total string Required
  
  total_in_bytes number Required
  
  plugins array[object]
  
  Hide plugins attributes Show plugins attributes object
  
  classname string Required
  
  description string Required
  
  elasticsearch_version string Required
  
  extended_plugins array[string] Required
  
  has_native_controller boolean Required
  
  java_version string Required
  
  name string Required
  
  version string Required
  
  licensed boolean Required
  
  process object
  
  Hide process attributes Show process attributes object
  
  id number Required
  
  Process identifier (PID)
  
  mlockall boolean Required
  
  Indicates if the process address space has been successfully locked in memory
  
  Time unit for milliseconds
  
  roles array[string] Required
  
  @doc_id node-roles
  
  Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.
  
  settings object
  
  Hide settings attributes Show settings attributes object
  
  cluster object Required
  
  Hide cluster attributes Show cluster attributes object
  
  name string Required
  
  routing object
  
  election object Required
  
  initial_master_nodes array[string]
  
  deprecation_indexing object
  
  node object Required
  
  Hide node attributes Show node attributes object
  
  name string Required
  
  attr object Required
  
  max_local_storage_nodes string
  
  path object
  
  Hide path attributes Show path attributes object
  
  logs string
  
  home string
  
  repo array[string]
  
  data
  
  repositories object
  
  Hide repositories attribute Show repositories attribute object
  
  url object Required
  
  discovery object
  
  Hide discovery attributes Show discovery attributes object
  
  seed_hosts array[string]
  
  type string
  
  seed_providers array[string]
  
  action object
  
  Hide action attribute Show action attribute object
  
  destructive_requires_name string Required
  
  client object
  
  Hide client attribute Show client attribute object
  
  type string Required
  
  http object Required
  
  Hide http attributes Show http attributes object
  
  type object Required
  
  type.default string
  
  compression
  
  port
  
  bootstrap object
  
  Hide bootstrap attribute Show bootstrap attribute object
  
  memory_lock string Required
  
  transport object Required
  
  Hide transport attributes Show transport attributes object
  
  type object Required
  
  type.default string
  
  features object
  
  network object
  
  Hide network attribute Show network attribute object
  
  host
  
  xpack object
  
  Hide xpack attributes Show xpack attributes object
  
  license object
  
  security object Required
  
  notification object
  
  ml object
  
  script object
  
  Hide script attributes Show script attributes object
  
  allowed_types string Required
  
  disable_max_compilations_rate string
  
  search object
  
  Hide search attribute Show search attribute object
  
  remote object Required
  
  ingest object
  
  Hide ingest attributes Show ingest attributes object
  
  attachment object
  
  append object
  
  csv object
  
  convert object
  
  date object
  
  date_index_name object
  
  dot_expander object
  
  enrich object
  
  fail object
  
  foreach object
  
  json object
  
  user_agent object
  
  kv object
  
  geoip object
  
  grok object
  
  gsub object
  
  join object
  
  lowercase object
  
  remove object
  
  rename object
  
  script object
  
  set object
  
  sort object
  
  split object
  
  trim object
  
  uppercase object
  
  urldecode object
  
  bytes object
  
  dissect object
  
  set_security_user object
  
  pipeline object
  
  drop object
  
  circle object
  
  inference object
  
  thread_pool object
  
  Hide thread_pool attribute Show thread_pool attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  core number
  
  keep_alive string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  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
  
  One of:
  ByteSize number ByteSize string
  
  transport object
  
  Hide transport attributes Show transport attributes object
  
  bound_address array[string] Required
  
  publish_address string Required
  
  profiles object Required
  
  Hide profiles attribute Show profiles attribute object
  
  * string Additional properties
  
  transport_address string Required
  
  version string Required
  
  modules array[object]
  
  Hide modules attributes Show modules attributes object
  
  classname string Required
  
  description string Required
  
  elasticsearch_version string Required
  
  extended_plugins array[string] Required
  
  has_native_controller boolean Required
  
  java_version string Required
  
  name string Required
  
  version string Required
  
  licensed boolean Required
  
  ingest object
  
  Hide ingest attribute Show ingest attribute object
  
  processors array[object] Required
  
  aggregations object
  
  Hide aggregations attribute Show aggregations attribute object
  
  * object Additional properties
  
  Hide * attribute Show * attribute object
  
  types array[string] Required

GET /_nodes/{node_id}

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

Response examples (200)

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
          }
        ]
      }
    }
}

Get node information Added in 1.3.0

GET /_nodes/{node_id}/{metric}

Api key auth Basic auth Bearer auth

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

Path parameters

node_id string | array[string] Required

Comma-separated list of node IDs or names used to limit returned information.
metric string | array[string] Required

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

Query parameters

flat_settings boolean

If true, returns settings in flat format.
timeout string

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

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string
  
  A human-readable explanation of the error, in English.
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  root_cause array[object]
  
  suppressed array[object]
  
  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 object Required
  
  Hide nodes attribute Show nodes attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  attributes object Required
  
  Hide attributes attribute Show attributes attribute object
  
  * string Additional properties
  
  build_flavor string Required
  
  build_hash string Required
  
  Short hash of the last git commit in this release.
  
  build_type string Required
  
  host string Required
  
  http object
  
  Hide http attributes Show http attributes object
  
  bound_address array[string] Required
  
  max_content_length number | string
  
  One of:
  ByteSize number ByteSize string
  
  max_content_length_in_bytes number Required
  
  publish_address string Required
  
  ip string Required
  
  jvm object
  
  Hide jvm attributes Show jvm attributes object
  
  gc_collectors array[string] Required
  
  mem object Required
  
  Hide mem attributes Show mem attributes object
  
  direct_max
  
  direct_max_in_bytes number Required
  
  heap_init
  
  heap_init_in_bytes number Required
  
  heap_max
  
  heap_max_in_bytes number Required
  
  non_heap_init
  
  non_heap_init_in_bytes number Required
  
  non_heap_max
  
  non_heap_max_in_bytes number Required
  
  memory_pools array[string] Required
  
  pid number Required
  
  Time unit for milliseconds
  
  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
  
  One of:
  boolean-1 boolean string-2 string
  
  input_arguments array[string] Required
  
  name string Required
  
  network object
  
  Hide network attributes Show network attributes object
  
  primary_interface object Required
  
  Hide primary_interface attributes Show primary_interface attributes object
  
  address string Required
  
  mac_address string Required
  
  name string Required
  
  refresh_interval number Required
  
  os object
  
  Hide os attributes Show os attributes 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
  
  pretty_name string Required
  
  Time unit for milliseconds
  
  version string Required
  
  cpu object
  
  Hide cpu attributes Show cpu attributes 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
  
  Hide mem attributes Show mem attributes object
  
  total string Required
  
  total_in_bytes number Required
  
  swap object
  
  Hide swap attributes Show swap attributes object
  
  total string Required
  
  total_in_bytes number Required
  
  plugins array[object]
  
  Hide plugins attributes Show plugins attributes object
  
  classname string Required
  
  description string Required
  
  elasticsearch_version string Required
  
  extended_plugins array[string] Required
  
  has_native_controller boolean Required
  
  java_version string Required
  
  name string Required
  
  version string Required
  
  licensed boolean Required
  
  process object
  
  Hide process attributes Show process attributes object
  
  id number Required
  
  Process identifier (PID)
  
  mlockall boolean Required
  
  Indicates if the process address space has been successfully locked in memory
  
  Time unit for milliseconds
  
  roles array[string] Required
  
  @doc_id node-roles
  
  Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.
  
  settings object
  
  Hide settings attributes Show settings attributes object
  
  cluster object Required
  
  Hide cluster attributes Show cluster attributes object
  
  name string Required
  
  routing object
  
  election object Required
  
  initial_master_nodes array[string]
  
  deprecation_indexing object
  
  node object Required
  
  Hide node attributes Show node attributes object
  
  name string Required
  
  attr object Required
  
  max_local_storage_nodes string
  
  path object
  
  Hide path attributes Show path attributes object
  
  logs string
  
  home string
  
  repo array[string]
  
  data
  
  repositories object
  
  Hide repositories attribute Show repositories attribute object
  
  url object Required
  
  discovery object
  
  Hide discovery attributes Show discovery attributes object
  
  seed_hosts array[string]
  
  type string
  
  seed_providers array[string]
  
  action object
  
  Hide action attribute Show action attribute object
  
  destructive_requires_name string Required
  
  client object
  
  Hide client attribute Show client attribute object
  
  type string Required
  
  http object Required
  
  Hide http attributes Show http attributes object
  
  type object Required
  
  type.default string
  
  compression
  
  port
  
  bootstrap object
  
  Hide bootstrap attribute Show bootstrap attribute object
  
  memory_lock string Required
  
  transport object Required
  
  Hide transport attributes Show transport attributes object
  
  type object Required
  
  type.default string
  
  features object
  
  network object
  
  Hide network attribute Show network attribute object
  
  host
  
  xpack object
  
  Hide xpack attributes Show xpack attributes object
  
  license object
  
  security object Required
  
  notification object
  
  ml object
  
  script object
  
  Hide script attributes Show script attributes object
  
  allowed_types string Required
  
  disable_max_compilations_rate string
  
  search object
  
  Hide search attribute Show search attribute object
  
  remote object Required
  
  ingest object
  
  Hide ingest attributes Show ingest attributes object
  
  attachment object
  
  append object
  
  csv object
  
  convert object
  
  date object
  
  date_index_name object
  
  dot_expander object
  
  enrich object
  
  fail object
  
  foreach object
  
  json object
  
  user_agent object
  
  kv object
  
  geoip object
  
  grok object
  
  gsub object
  
  join object
  
  lowercase object
  
  remove object
  
  rename object
  
  script object
  
  set object
  
  sort object
  
  split object
  
  trim object
  
  uppercase object
  
  urldecode object
  
  bytes object
  
  dissect object
  
  set_security_user object
  
  pipeline object
  
  drop object
  
  circle object
  
  inference object
  
  thread_pool object
  
  Hide thread_pool attribute Show thread_pool attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  core number
  
  keep_alive string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  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
  
  One of:
  ByteSize number ByteSize string
  
  transport object
  
  Hide transport attributes Show transport attributes object
  
  bound_address array[string] Required
  
  publish_address string Required
  
  profiles object Required
  
  Hide profiles attribute Show profiles attribute object
  
  * string Additional properties
  
  transport_address string Required
  
  version string Required
  
  modules array[object]
  
  Hide modules attributes Show modules attributes object
  
  classname string Required
  
  description string Required
  
  elasticsearch_version string Required
  
  extended_plugins array[string] Required
  
  has_native_controller boolean Required
  
  java_version string Required
  
  name string Required
  
  version string Required
  
  licensed boolean Required
  
  ingest object
  
  Hide ingest attribute Show ingest attribute object
  
  processors array[object] Required
  
  aggregations object
  
  Hide aggregations attribute Show aggregations attribute object
  
  * object Additional properties
  
  Hide * attribute Show * attribute object
  
  types array[string] Required

GET /_nodes/{node_id}/{metric}

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

Response examples (200)

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
          }
        ]
      }
    }
}

Reload the keystore on nodes in the cluster Added in 6.5.0

POST /_nodes/reload_secure_settings

Api key auth Basic auth Bearer auth

Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node.

When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password.

Query parameters

timeout string

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

application/json

Body

secure_settings_password string

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string
  
  A human-readable explanation of the error, in English.
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  root_cause array[object]
  
  suppressed array[object]
  
  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 object Required
  
  Hide nodes attribute Show nodes attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  name string Required
  
  reload_exception object
  
  Hide reload_exception attributes Show reload_exception attributes object
  
  type string Required
  
  The type of error
  
  reason string
  
  A human-readable explanation of the error, in English.
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  root_cause array[object]
  
  suppressed array[object]

POST /_nodes/reload_secure_settings

curl \
 --request POST 'http://api.example.com/_nodes/reload_secure_settings' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"secure_settings_password\": \"keystore-password\"\n}"'

Request example

Run `POST _nodes/reload_secure_settings` to reload the keystore on nodes in the cluster.

{
  "secure_settings_password": "keystore-password"
}

Response examples (200)

A successful response when reloading keystore on nodes in your cluster.

{
  "_nodes": {
    "total": 1,
    "successful": 1,
    "failed": 0
  },
  "cluster_name": "my_cluster",
  "nodes": {
    "pQHNt5rXTTWNvUgOrdynKg": {
      "name": "node-0"
    }
  }
}

GET /_nodes/{node_id}/stats

Api key auth Basic auth Bearer auth

Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics.

Path parameters

node_id string | array[string] Required

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

Query parameters

completion_fields string | array[string]

Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
fielddata_fields string | array[string]

Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
fields string | array[string]

Comma-separated list or wildcard expressions of fields to include in the statistics.
groups boolean

Comma-separated list of search groups to include in the search statistics.
include_segment_file_sizes boolean

If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
level string

Indicates whether statistics are aggregated at the cluster, index, or shard level.

Values are cluster, indices, or shards.
timeout string

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

A comma-separated list of document types for the indexing index metric.
include_unloaded_segments boolean

If true, the response includes information from segments that are not loaded into memory.

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string
  
  A human-readable explanation of the error, in English.
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  root_cause array[object]
  
  suppressed array[object]
  
  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
- nodes object Required
  
  Hide nodes attribute Show nodes attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  adaptive_selection object
  
  Statistics about adaptive replica selection.
  
  Hide adaptive_selection attribute Show adaptive_selection attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  avg_queue_size number
  
  The exponentially weighted moving average queue size of search requests on the keyed node.
  
  avg_response_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  avg_response_time_ns number
  
  The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node.
  
  avg_service_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  avg_service_time_ns number
  
  The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node.
  
  outgoing_searches number
  
  The number of outstanding search requests to the keyed node from the node these stats are for.
  
  rank string
  
  The rank of this node; used for shard selection when routing search requests.
  
  breakers object
  
  Statistics about the field data circuit breaker.
  
  Hide breakers attribute Show breakers attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  estimated_size string
  
  Estimated memory used for the operation.
  
  estimated_size_in_bytes number
  
  Estimated memory used, in bytes, for the operation.
  
  limit_size string
  
  Memory limit for the circuit breaker.
  
  limit_size_in_bytes number
  
  Memory limit, in bytes, for the circuit breaker.
  
  overhead number
  
  A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate.
  
  tripped number
  
  Total number of times the circuit breaker has been triggered and prevented an out of memory error.
  
  fs object
  
  Hide fs attributes Show fs attributes object
  
  data array[object]
  
  List of all file stores.
  
  timestamp number
  
  Last time the file stores statistics were refreshed. Recorded in milliseconds since the Unix Epoch.
  
  total object
  
  Hide total attributes Show total attributes object
  
  available string
  
  Total disk space available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than free. This is the actual amount of free disk space the Elasticsearch node can utilise.
  
  available_in_bytes number
  
  Total number of bytes available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than free_in_bytes. This is the actual amount of free disk space the Elasticsearch node can utilise.
  
  free string
  
  Total unallocated disk space in all file stores.
  
  free_in_bytes number
  
  Total number of unallocated bytes in all file stores.
  
  total string
  
  Total size of all file stores.
  
  total_in_bytes number
  
  Total size of all file stores in bytes.
  
  io_stats object
  
  Hide io_stats attributes Show io_stats attributes object
  
  devices array[object]
  
  Array of disk metrics for each device that is backing an Elasticsearch data path. These disk metrics are probed periodically and averages between the last probe and the current probe are computed.
  
  total object
  
  host string
  
  http object
  
  Hide http attributes Show http attributes object
  
  current_open number
  
  Current number of open HTTP connections for the node.
  
  total_opened number
  
  Total number of HTTP connections opened for the node.
  
  clients array[object]
  
  Information on current and recently-closed HTTP client connections. Clients that have been closed longer than the http.client_stats.closed_channels.max_age setting will not be represented here.
  
  routes object Required Added in 8.12.0
  
  Detailed HTTP stats broken down by route
  
  Hide routes attribute Show routes attribute object
  
  * object Additional properties
  
  ingest object
  
  Hide ingest attributes Show ingest attributes object
  
  pipelines object
  
  Contains statistics about ingest pipelines for the node.
  
  Hide pipelines attribute Show pipelines attribute object
  
  * object Additional properties
  
  total object
  
  Hide total attributes Show total attributes object
  
  count number Required
  
  Total number of documents ingested during the lifetime of this node.
  
  current number Required
  
  Total number of documents currently being ingested.
  
  failed number Required
  
  Total number of failed ingest operations during the lifetime of this node.
  
  ip string | array[string]
  
  IP address and port for the node.
  
  One of:
  Ip string array-2 array[string]
  
  jvm object
  
  Hide jvm attributes Show jvm attributes object
  
  buffer_pools object
  
  Contains statistics about JVM buffer pools for the node.
  
  Hide buffer_pools attribute Show buffer_pools attribute object
  
  * object Additional properties
  
  classes object
  
  Hide classes attributes Show classes attributes object
  
  current_loaded_count number
  
  Number of classes currently loaded by JVM.
  
  total_loaded_count number
  
  Total number of classes loaded since the JVM started.
  
  total_unloaded_count number
  
  Total number of classes unloaded since the JVM started.
  
  gc object
  
  Hide gc attribute Show gc attribute object
  
  collectors object
  
  Contains statistics about JVM garbage collectors for the node.
  
  mem object
  
  Hide mem attributes Show mem attributes object
  
  heap_used_in_bytes number
  
  Memory, in bytes, currently in use by the heap.
  
  heap_used_percent number
  
  Percentage of memory currently in use by the heap.
  
  heap_committed_in_bytes number
  
  Amount of memory, in bytes, available for use by the heap.
  
  heap_max_in_bytes number
  
  Maximum amount of memory, in bytes, available for use by the heap.
  
  non_heap_used_in_bytes number
  
  Non-heap memory used, in bytes.
  
  non_heap_committed_in_bytes number
  
  Amount of non-heap memory available, in bytes.
  
  pools object
  
  Contains statistics about heap memory usage for the node.
  
  threads object
  
  Hide threads attributes Show threads attributes object
  
  count number
  
  Number of active threads in use by JVM.
  
  peak_count number
  
  Highest number of threads used by JVM.
  
  timestamp number
  
  Last time JVM statistics were refreshed.
  
  uptime string
  
  Human-readable JVM uptime. Only returned if the human query parameter is true.
  
  uptime_in_millis number
  
  JVM uptime in milliseconds.
  
  name string
  
  os object
  
  Hide os attributes Show os attributes object
  
  cpu object
  
  Hide cpu attributes Show cpu attributes object
  
  percent number
  
  sys string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  total string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  user string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  load_average object
  
  swap object
  
  Hide swap attributes Show swap attributes object
  
  adjusted_total_in_bytes number
  
  If the amount of physical memory has been overridden using the es.total_memory_bytes system property then this reports the overridden value in bytes. Otherwise it reports the same value as total_in_bytes.
  
  resident string
  
  resident_in_bytes number
  
  share string
  
  share_in_bytes number
  
  total_virtual string
  
  total_virtual_in_bytes number
  
  total_in_bytes number
  
  Total amount of physical memory in bytes.
  
  free_in_bytes number
  
  Amount of free physical memory in bytes.
  
  used_in_bytes number
  
  Amount of used physical memory in bytes.
  
  cgroup object
  
  Hide cgroup attributes Show cgroup attributes object
  
  cpuacct object
  
  cpu object
  
  memory object
  
  timestamp number
  
  process object
  
  Hide process attributes Show process attributes object
  
  cpu object
  
  Hide cpu attributes Show cpu attributes object
  
  percent number
  
  sys string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  total string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  user string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  load_average object
  
  mem object
  
  Hide mem attributes Show mem attributes object
  
  adjusted_total_in_bytes number
  
  If the amount of physical memory has been overridden using the es.total_memory_bytes system property then this reports the overridden value in bytes. Otherwise it reports the same value as total_in_bytes.
  
  resident string
  
  resident_in_bytes number
  
  share string
  
  share_in_bytes number
  
  total_virtual string
  
  total_virtual_in_bytes number
  
  total_in_bytes number
  
  Total amount of physical memory in bytes.
  
  free_in_bytes number
  
  Amount of free physical memory in bytes.
  
  used_in_bytes number
  
  Amount of used physical memory in bytes.
  
  open_file_descriptors number
  
  Number of opened file descriptors associated with the current or -1 if not supported.
  
  max_file_descriptors number
  
  Maximum number of file descriptors allowed on the system, or -1 if not supported.
  
  timestamp number
  
  Last time the statistics were refreshed. Recorded in milliseconds since the Unix Epoch.
  
  roles array[string]
  
  @doc_id node-roles
  
  Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.
  
  script object
  
  Hide script attributes Show script attributes object
  
  cache_evictions number
  
  Total number of times the script cache has evicted old data.
  
  compilations number
  
  Total number of inline script compilations performed by the node.
  
  compilations_history object
  
  Contains this recent history of script compilations.
  
  Hide compilations_history attribute Show compilations_history attribute object
  
  * number Additional properties
  
  compilation_limit_triggered number
  
  Total number of times the script compilation circuit breaker has limited inline script compilations.
  
  contexts array[object]
  
  script_cache object
  
  thread_pool object
  
  Statistics about each thread pool, including current size, queue and rejected tasks.
  
  Hide thread_pool attribute Show thread_pool attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  active number
  
  Number of active threads in the thread pool.
  
  completed number
  
  Number of tasks completed by the thread pool executor.
  
  largest number
  
  Highest number of active threads in the thread pool.
  
  queue number
  
  Number of tasks in queue for the thread pool.
  
  rejected number
  
  Number of tasks rejected by the thread pool executor.
  
  threads number
  
  Number of threads in the thread pool.
  
  timestamp number
  
  transport object
  
  Hide transport attributes Show transport attributes object
  
  inbound_handling_time_histogram array[object]
  
  The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram.
  
  outbound_handling_time_histogram array[object]
  
  The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram.
  
  rx_count number
  
  Total number of RX (receive) packets received by the node during internal cluster communication.
  
  rx_size string
  
  Size of RX packets received by the node during internal cluster communication.
  
  rx_size_in_bytes number
  
  Size, in bytes, of RX packets received by the node during internal cluster communication.
  
  server_open number
  
  Current number of inbound TCP connections used for internal communication between nodes.
  
  tx_count number
  
  Total number of TX (transmit) packets sent by the node during internal cluster communication.
  
  tx_size string
  
  Size of TX packets sent by the node during internal cluster communication.
  
  tx_size_in_bytes number
  
  Size, in bytes, of TX packets sent by the node during internal cluster communication.
  
  total_outbound_connections number
  
  The cumulative number of outbound transport connections that this node has opened since it started. Each transport connection may comprise multiple TCP connections but is only counted once in this statistic. Transport connections are typically long-lived so this statistic should remain constant in a stable cluster.
  
  transport_address string
  
  attributes object
  
  Contains a list of attributes for the node.
  
  Hide attributes attribute Show attributes attribute object
  
  * string Additional properties
  
  discovery object
  
  Hide discovery attributes Show discovery attributes object
  
  cluster_state_queue object
  
  Hide cluster_state_queue attributes Show cluster_state_queue attributes object
  
  total number
  
  Total number of cluster states in queue.
  
  pending number
  
  Number of pending cluster states in queue.
  
  committed number
  
  Number of committed cluster states in queue.
  
  published_cluster_states object
  
  Hide published_cluster_states attributes Show published_cluster_states attributes object
  
  full_states number
  
  Number of published cluster states.
  
  incompatible_diffs number
  
  Number of incompatible differences between published cluster states.
  
  compatible_diffs number
  
  Number of compatible differences between published cluster states.
  
  cluster_state_update object
  
  Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master. Omitted if the node is not master-eligible. Every field whose name ends in _time within this object is also represented as a raw number of milliseconds in a field whose name ends in _time_millis. The human-readable fields with a _time suffix are only returned if requested with the ?human=true query parameter.
  
  Hide cluster_state_update attribute Show cluster_state_update attribute object
  
  * object Additional properties
  
  serialized_cluster_states object
  
  Hide serialized_cluster_states attributes Show serialized_cluster_states attributes object
  
  full_states object
  
  diffs object
  
  cluster_applier_stats object
  
  Hide cluster_applier_stats attribute Show cluster_applier_stats attribute object
  
  recordings array[object]
  
  indexing_pressure object
  
  Hide indexing_pressure attribute Show indexing_pressure attribute object
  
  memory object
  
  Hide memory attributes Show memory attributes object
  
  limit
  
  limit_in_bytes number
  
  Configured memory limit, in bytes, for the indexing requests. Replica requests have an automatic limit that is 1.5x this value.
  
  current object
  
  total object
  
  indices object
  
  Hide indices attributes Show indices attributes object
  
  commit object
  
  Hide commit attributes Show commit attributes object
  
  generation number Required
  
  id string Required
  
  num_docs number Required
  
  user_data object Required
  
  completion object
  
  Hide completion attributes Show completion attributes object
  
  size_in_bytes number Required
  
  Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
  
  size
  
  fields object
  
  docs object
  
  Hide docs attributes Show docs attributes object
  
  count number Required
  
  Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.
  
  deleted number
  
  Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
  
  fielddata object
  
  Hide fielddata attributes Show fielddata attributes object
  
  evictions number
  
  memory_size
  
  memory_size_in_bytes number Required
  
  fields object
  
  flush object
  
  Hide flush attributes Show flush attributes object
  
  periodic number Required
  
  total number Required
  
  total_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  get object
  
  Hide get attributes Show get attributes object
  
  current number Required
  
  exists_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  exists_total number Required
  
  missing_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  missing_total number Required
  
  time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  total number Required
  
  indexing object
  
  Hide indexing attributes Show indexing attributes object
  
  index_current number Required
  
  delete_current number Required
  
  delete_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  delete_total number Required
  
  is_throttled boolean Required
  
  noop_update_total number Required
  
  throttle_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  index_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  index_total number Required
  
  index_failed number Required
  
  types object
  
  write_load number
  
  mappings object
  
  Hide mappings attributes Show mappings attributes object
  
  total_count number Required
  
  total_estimated_overhead
  
  total_estimated_overhead_in_bytes number Required
  
  merges object
  
  Hide merges attributes Show merges attributes object
  
  current number Required
  
  current_docs number Required
  
  current_size string
  
  current_size_in_bytes number Required
  
  total number Required
  
  total_auto_throttle string
  
  total_auto_throttle_in_bytes number Required
  
  total_docs number Required
  
  total_size string
  
  total_size_in_bytes number Required
  
  total_stopped_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  total_throttled_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  total_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  shard_path object
  
  Hide shard_path attributes Show shard_path attributes object
  
  data_path string Required
  
  is_custom_data_path boolean Required
  
  state_path string Required
  
  query_cache object
  
  Hide query_cache attributes Show query_cache attributes object
  
  cache_count number Required
  
  cache_size number Required
  
  evictions number Required
  
  hit_count number Required
  
  memory_size_in_bytes number Required
  
  miss_count number Required
  
  total_count number Required
  
  recovery object
  
  Hide recovery attributes Show recovery attributes object
  
  current_as_source number Required
  
  current_as_target number Required
  
  throttle_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  refresh object
  
  Hide refresh attributes Show refresh attributes object
  
  external_total number Required
  
  listeners number Required
  
  total number Required
  
  total_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  request_cache object
  
  Hide request_cache attributes Show request_cache attributes object
  
  evictions number Required
  
  hit_count number Required
  
  memory_size string
  
  memory_size_in_bytes number Required
  
  miss_count number Required
  
  retention_leases object
  
  Hide retention_leases attributes Show retention_leases attributes object
  
  primary_term number Required
  
  version number Required
  
  leases array[object] Required
  
  routing object
  
  Hide routing attributes Show routing attributes object
  
  node string Required
  
  primary boolean Required
  
  relocating_node
  
  state string Required
  
  Values are UNASSIGNED, INITIALIZING, STARTED, or RELOCATING.
  
  search object
  
  Hide search attributes Show search attributes object
  
  fetch_current number Required
  
  fetch_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  fetch_total number Required
  
  open_contexts number
  
  query_current number Required
  
  query_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  query_total number Required
  
  scroll_current number Required
  
  scroll_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  scroll_total number Required
  
  suggest_current number Required
  
  suggest_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  suggest_total number Required
  
  groups object
  
  segments object
  
  Hide segments attributes Show segments attributes object
  
  count number Required
  
  Total number of segments across all shards assigned to selected nodes.
  
  doc_values_memory
  
  doc_values_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
  
  file_sizes object Required
  
  This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
  
  fixed_bit_set
  
  fixed_bit_set_memory_in_bytes number Required
  
  Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
  
  index_writer_memory
  
  index_writer_max_memory_in_bytes number
  
  index_writer_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
  
  max_unsafe_auto_id_timestamp number Required
  
  Unix timestamp, in milliseconds, of the most recently retried indexing request.
  
  memory
  
  memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
  
  norms_memory
  
  norms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
  
  points_memory
  
  points_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
  
  stored_memory
  
  stored_fields_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
  
  terms_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
  
  terms_memory
  
  term_vectory_memory
  
  term_vectors_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
  
  version_map_memory
  
  version_map_memory_in_bytes number Required
  
  Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
  
  seq_no object
  
  Hide seq_no attributes Show seq_no attributes object
  
  global_checkpoint number Required
  
  local_checkpoint number Required
  
  max_seq_no number Required
  
  store object
  
  Hide store attributes Show store attributes object
  
  size
  
  size_in_bytes number Required
  
  Total size, in bytes, of all shards assigned to selected nodes.
  
  reserved
  
  reserved_in_bytes number Required
  
  A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
  
  total_data_set_size
  
  total_data_set_size_in_bytes number
  
  Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.
  
  translog object
  
  Hide translog attributes Show translog attributes object
  
  earliest_last_modified_age number Required
  
  operations number Required
  
  size string
  
  size_in_bytes number Required
  
  uncommitted_operations number Required
  
  uncommitted_size string
  
  uncommitted_size_in_bytes number Required
  
  warmer object
  
  Hide warmer attributes Show warmer attributes object
  
  current number Required
  
  total number Required
  
  total_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  bulk object
  
  Hide bulk attributes Show bulk attributes object
  
  total_operations number Required
  
  total_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  total_size
  
  total_size_in_bytes number Required
  
  avg_time string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  avg_size
  
  avg_size_in_bytes number Required
  
  shards object
  
  Hide shards attribute Show shards attribute object
  
  * object Additional properties
  
  shard_stats object
  
  Hide shard_stats attribute Show shard_stats attribute object
  
  total_count number Required
  
  indices object Additional properties
  
  Hide indices attributes Show indices attributes object
  
  primaries object
  
  shards object
  
  total object
  
  uuid string
  
  health string
  
  Values are green, GREEN, yellow, YELLOW, red, or RED.
  
  status string
  
  Values are open or close.

GET /_nodes/{node_id}/stats

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

Response examples (200)

{
  "_nodes": {
    "failures": [
      {
        "type": "string",
        "reason": "string",
        "stack_trace": "string",
        "caused_by": {},
        "root_cause": [
          {}
        ],
        "suppressed": [
          {}
        ]
      }
    ],
    "total": 42.0,
    "successful": 42.0,
    "failed": 42.0
  },
  "cluster_name": "string",
  "nodes": {
    "additionalProperty1": {
      "adaptive_selection": {
        "additionalProperty1": {
          "avg_queue_size": 42.0,
          "avg_response_time": "string",
          "avg_response_time_ns": 42.0,
          "avg_service_time": "string",
          "avg_service_time_ns": 42.0,
          "outgoing_searches": 42.0,
          "rank": "string"
        },
        "additionalProperty2": {
          "avg_queue_size": 42.0,
          "avg_response_time": "string",
          "avg_response_time_ns": 42.0,
          "avg_service_time": "string",
          "avg_service_time_ns": 42.0,
          "outgoing_searches": 42.0,
          "rank": "string"
        }
      },
      "breakers": {
        "additionalProperty1": {
          "estimated_size": "string",
          "estimated_size_in_bytes": 42.0,
          "limit_size": "string",
          "limit_size_in_bytes": 42.0,
          "overhead": 42.0,
          "tripped": 42.0
        },
        "additionalProperty2": {
          "estimated_size": "string",
          "estimated_size_in_bytes": 42.0,
          "limit_size": "string",
          "limit_size_in_bytes": 42.0,
          "overhead": 42.0,
          "tripped": 42.0
        }
      },
      "fs": {
        "data": [
          {}
        ],
        "timestamp": 42.0,
        "total": {
          "available": "string",
          "available_in_bytes": 42.0,
          "free": "string",
          "free_in_bytes": 42.0,
          "total": "string",
          "total_in_bytes": 42.0
        },
        "io_stats": {
          "devices": [
            {}
          ],
          "total": {}
        }
      },
      "host": "string",
      "http": {
        "current_open": 42.0,
        "total_opened": 42.0,
        "clients": [
          {}
        ],
        "routes": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        }
      },
      "ingest": {
        "pipelines": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        },
        "total": {
          "count": 42.0,
          "current": 42.0,
          "failed": 42.0
        }
      },
      "ip": "string",
      "jvm": {
        "buffer_pools": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        },
        "classes": {
          "current_loaded_count": 42.0,
          "total_loaded_count": 42.0,
          "total_unloaded_count": 42.0
        },
        "gc": {
          "collectors": {}
        },
        "mem": {
          "heap_used_in_bytes": 42.0,
          "heap_used_percent": 42.0,
          "heap_committed_in_bytes": 42.0,
          "heap_max_in_bytes": 42.0,
          "non_heap_used_in_bytes": 42.0,
          "non_heap_committed_in_bytes": 42.0,
          "pools": {}
        },
        "threads": {
          "count": 42.0,
          "peak_count": 42.0
        },
        "timestamp": 42.0,
        "uptime": "string",
        "uptime_in_millis": 42.0
      },
      "name": "string",
      "os": {
        "cpu": {
          "percent": 42.0,
          "sys": "string",
          "total": "string",
          "user": "string",
          "load_average": {}
        },
        "": {},
        "swap": {
          "adjusted_total_in_bytes": 42.0,
          "resident": "string",
          "resident_in_bytes": 42.0,
          "share": "string",
          "share_in_bytes": 42.0,
          "total_virtual": "string",
          "total_virtual_in_bytes": 42.0,
          "total_in_bytes": 42.0,
          "free_in_bytes": 42.0,
          "used_in_bytes": 42.0
        },
        "cgroup": {
          "cpuacct": {},
          "cpu": {},
          "memory": {}
        },
        "timestamp": 42.0
      },
      "process": {
        "cpu": {
          "percent": 42.0,
          "sys": "string",
          "total": "string",
          "user": "string",
          "load_average": {}
        },
        "mem": {
          "adjusted_total_in_bytes": 42.0,
          "resident": "string",
          "resident_in_bytes": 42.0,
          "share": "string",
          "share_in_bytes": 42.0,
          "total_virtual": "string",
          "total_virtual_in_bytes": 42.0,
          "total_in_bytes": 42.0,
          "free_in_bytes": 42.0,
          "used_in_bytes": 42.0
        },
        "open_file_descriptors": 42.0,
        "max_file_descriptors": 42.0,
        "timestamp": 42.0
      },
      "roles": [
        "master"
      ],
      "script": {
        "cache_evictions": 42.0,
        "compilations": 42.0,
        "compilations_history": {
          "additionalProperty1": 42.0,
          "additionalProperty2": 42.0
        },
        "compilation_limit_triggered": 42.0,
        "contexts": [
          {}
        ]
      },
      "script_cache": {},
      "thread_pool": {
        "additionalProperty1": {
          "active": 42.0,
          "completed": 42.0,
          "largest": 42.0,
          "queue": 42.0,
          "rejected": 42.0,
          "threads": 42.0
        },
        "additionalProperty2": {
          "active": 42.0,
          "completed": 42.0,
          "largest": 42.0,
          "queue": 42.0,
          "rejected": 42.0,
          "threads": 42.0
        }
      },
      "timestamp": 42.0,
      "transport": {
        "inbound_handling_time_histogram": [
          {}
        ],
        "outbound_handling_time_histogram": [
          {}
        ],
        "rx_count": 42.0,
        "rx_size": "string",
        "rx_size_in_bytes": 42.0,
        "server_open": 42.0,
        "tx_count": 42.0,
        "tx_size": "string",
        "tx_size_in_bytes": 42.0,
        "total_outbound_connections": 42.0
      },
      "transport_address": "string",
      "attributes": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "discovery": {
        "cluster_state_queue": {
          "total": 42.0,
          "pending": 42.0,
          "committed": 42.0
        },
        "published_cluster_states": {
          "full_states": 42.0,
          "incompatible_diffs": 42.0,
          "compatible_diffs": 42.0
        },
        "cluster_state_update": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        },
        "serialized_cluster_states": {
          "full_states": {},
          "diffs": {}
        },
        "cluster_applier_stats": {
          "recordings": [
            {}
          ]
        }
      },
      "indexing_pressure": {
        "memory": {
          "limit_in_bytes": 42.0,
          "current": {},
          "total": {}
        }
      },
      "indices": {
        "commit": {
          "generation": 42.0,
          "id": "string",
          "num_docs": 42.0,
          "user_data": {}
        },
        "completion": {
          "size_in_bytes": 42.0,
          "fields": {}
        },
        "docs": {
          "count": 42.0,
          "deleted": 42.0
        },
        "fielddata": {
          "evictions": 42.0,
          "memory_size_in_bytes": 42.0,
          "fields": {}
        },
        "flush": {
          "periodic": 42.0,
          "total": 42.0,
          "total_time": "string"
        },
        "get": {
          "current": 42.0,
          "exists_time": "string",
          "exists_total": 42.0,
          "missing_time": "string",
          "missing_total": 42.0,
          "time": "string",
          "total": 42.0
        },
        "indexing": {
          "index_current": 42.0,
          "delete_current": 42.0,
          "delete_time": "string",
          "delete_total": 42.0,
          "is_throttled": true,
          "noop_update_total": 42.0,
          "throttle_time": "string",
          "index_time": "string",
          "index_total": 42.0,
          "index_failed": 42.0,
          "types": {},
          "write_load": 42.0
        },
        "mappings": {
          "total_count": 42.0,
          "total_estimated_overhead_in_bytes": 42.0
        },
        "merges": {
          "current": 42.0,
          "current_docs": 42.0,
          "current_size": "string",
          "current_size_in_bytes": 42.0,
          "total": 42.0,
          "total_auto_throttle": "string",
          "total_auto_throttle_in_bytes": 42.0,
          "total_docs": 42.0,
          "total_size": "string",
          "total_size_in_bytes": 42.0,
          "total_stopped_time": "string",
          "total_throttled_time": "string",
          "total_time": "string"
        },
        "shard_path": {
          "data_path": "string",
          "is_custom_data_path": true,
          "state_path": "string"
        },
        "query_cache": {
          "cache_count": 42.0,
          "cache_size": 42.0,
          "evictions": 42.0,
          "hit_count": 42.0,
          "memory_size_in_bytes": 42.0,
          "miss_count": 42.0,
          "total_count": 42.0
        },
        "recovery": {
          "current_as_source": 42.0,
          "current_as_target": 42.0,
          "throttle_time": "string"
        },
        "refresh": {
          "external_total": 42.0,
          "listeners": 42.0,
          "total": 42.0,
          "total_time": "string"
        },
        "request_cache": {
          "evictions": 42.0,
          "hit_count": 42.0,
          "memory_size": "string",
          "memory_size_in_bytes": 42.0,
          "miss_count": 42.0
        },
        "retention_leases": {
          "primary_term": 42.0,
          "version": 42.0,
          "leases": [
            {}
          ]
        },
        "routing": {
          "node": "string",
          "primary": true,
          "state": "UNASSIGNED"
        },
        "search": {
          "fetch_current": 42.0,
          "fetch_time": "string",
          "fetch_total": 42.0,
          "open_contexts": 42.0,
          "query_current": 42.0,
          "query_time": "string",
          "query_total": 42.0,
          "scroll_current": 42.0,
          "scroll_time": "string",
          "scroll_total": 42.0,
          "suggest_current": 42.0,
          "suggest_time": "string",
          "suggest_total": 42.0,
          "groups": {}
        },
        "segments": {
          "count": 42.0,
          "doc_values_memory_in_bytes": 42.0,
          "file_sizes": {},
          "fixed_bit_set_memory_in_bytes": 42.0,
          "index_writer_max_memory_in_bytes": 42.0,
          "index_writer_memory_in_bytes": 42.0,
          "max_unsafe_auto_id_timestamp": 42.0,
          "memory_in_bytes": 42.0,
          "norms_memory_in_bytes": 42.0,
          "points_memory_in_bytes": 42.0,
          "stored_fields_memory_in_bytes": 42.0,
          "terms_memory_in_bytes": 42.0,
          "term_vectors_memory_in_bytes": 42.0,
          "version_map_memory_in_bytes": 42.0
        },
        "seq_no": {
          "global_checkpoint": 42.0,
          "local_checkpoint": 42.0,
          "max_seq_no": 42.0
        },
        "store": {
          "size_in_bytes": 42.0,
          "reserved_in_bytes": 42.0,
          "total_data_set_size_in_bytes": 42.0
        },
        "translog": {
          "earliest_last_modified_age": 42.0,
          "operations": 42.0,
          "size": "string",
          "size_in_bytes": 42.0,
          "uncommitted_operations": 42.0,
          "uncommitted_size": "string",
          "uncommitted_size_in_bytes": 42.0
        },
        "warmer": {
          "current": 42.0,
          "total": 42.0,
          "total_time": "string"
        },
        "bulk": {
          "total_operations": 42.0,
          "total_time": "string",
          "total_size_in_bytes": 42.0,
          "avg_time": "string",
          "avg_size_in_bytes": 42.0
        },
        "shards": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        },
        "shard_stats": {
          "total_count": 42.0
        },
        "additionalProperty1": {
          "primaries": {},
          "shards": {},
          "total": {},
          "uuid": "string",
          "health": "green",
          "status": "open"
        },
        "additionalProperty2": {
          "primaries": {},
          "shards": {},
          "total": {},
          "uuid": "string",
          "health": "green",
          "status": "open"
        }
      }
    },
    "additionalProperty2": {
      "adaptive_selection": {
        "additionalProperty1": {
          "avg_queue_size": 42.0,
          "avg_response_time": "string",
          "avg_response_time_ns": 42.0,
          "avg_service_time": "string",
          "avg_service_time_ns": 42.0,
          "outgoing_searches": 42.0,
          "rank": "string"
        },
        "additionalProperty2": {
          "avg_queue_size": 42.0,
          "avg_response_time": "string",
          "avg_response_time_ns": 42.0,
          "avg_service_time": "string",
          "avg_service_time_ns": 42.0,
          "outgoing_searches": 42.0,
          "rank": "string"
        }
      },
      "breakers": {
        "additionalProperty1": {
          "estimated_size": "string",
          "estimated_size_in_bytes": 42.0,
          "limit_size": "string",
          "limit_size_in_bytes": 42.0,
          "overhead": 42.0,
          "tripped": 42.0
        },
        "additionalProperty2": {
          "estimated_size": "string",
          "estimated_size_in_bytes": 42.0,
          "limit_size": "string",
          "limit_size_in_bytes": 42.0,
          "overhead": 42.0,
          "tripped": 42.0
        }
      },
      "fs": {
        "data": [
          {}
        ],
        "timestamp": 42.0,
        "total": {
          "available": "string",
          "available_in_bytes": 42.0,
          "free": "string",
          "free_in_bytes": 42.0,
          "total": "string",
          "total_in_bytes": 42.0
        },
        "io_stats": {
          "devices": [
            {}
          ],
          "total": {}
        }
      },
      "host": "string",
      "http": {
        "current_open": 42.0,
        "total_opened": 42.0,
        "clients": [
          {}
        ],
        "routes": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        }
      },
      "ingest": {
        "pipelines": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        },
        "total": {
          "count": 42.0,
          "current": 42.0,
          "failed": 42.0
        }
      },
      "ip": "string",
      "jvm": {
        "buffer_pools": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        },
        "classes": {
          "current_loaded_count": 42.0,
          "total_loaded_count": 42.0,
          "total_unloaded_count": 42.0
        },
        "gc": {
          "collectors": {}
        },
        "mem": {
          "heap_used_in_bytes": 42.0,
          "heap_used_percent": 42.0,
          "heap_committed_in_bytes": 42.0,
          "heap_max_in_bytes": 42.0,
          "non_heap_used_in_bytes": 42.0,
          "non_heap_committed_in_bytes": 42.0,
          "pools": {}
        },
        "threads": {
          "count": 42.0,
          "peak_count": 42.0
        },
        "timestamp": 42.0,
        "uptime": "string",
        "uptime_in_millis": 42.0
      },
      "name": "string",
      "os": {
        "cpu": {
          "percent": 42.0,
          "sys": "string",
          "total": "string",
          "user": "string",
          "load_average": {}
        },
        "": {},
        "swap": {
          "adjusted_total_in_bytes": 42.0,
          "resident": "string",
          "resident_in_bytes": 42.0,
          "share": "string",
          "share_in_bytes": 42.0,
          "total_virtual": "string",
          "total_virtual_in_bytes": 42.0,
          "total_in_bytes": 42.0,
          "free_in_bytes": 42.0,
          "used_in_bytes": 42.0
        },
        "cgroup": {
          "cpuacct": {},
          "cpu": {},
          "memory": {}
        },
        "timestamp": 42.0
      },
      "process": {
        "cpu": {
          "percent": 42.0,
          "sys": "string",
          "total": "string",
          "user": "string",
          "load_average": {}
        },
        "mem": {
          "adjusted_total_in_bytes": 42.0,
          "resident": "string",
          "resident_in_bytes": 42.0,
          "share": "string",
          "share_in_bytes": 42.0,
          "total_virtual": "string",
          "total_virtual_in_bytes": 42.0,
          "total_in_bytes": 42.0,
          "free_in_bytes": 42.0,
          "used_in_bytes": 42.0
        },
        "open_file_descriptors": 42.0,
        "max_file_descriptors": 42.0,
        "timestamp": 42.0
      },
      "roles": [
        "master"
      ],
      "script": {
        "cache_evictions": 42.0,
        "compilations": 42.0,
        "compilations_history": {
          "additionalProperty1": 42.0,
          "additionalProperty2": 42.0
        },
        "compilation_limit_triggered": 42.0,
        "contexts": [
          {}
        ]
      },
      "script_cache": {},
      "thread_pool": {
        "additionalProperty1": {
          "active": 42.0,
          "completed": 42.0,
          "largest": 42.0,
          "queue": 42.0,
          "rejected": 42.0,
          "threads": 42.0
        },
        "additionalProperty2": {
          "active": 42.0,
          "completed": 42.0,
          "largest": 42.0,
          "queue": 42.0,
          "rejected": 42.0,
          "threads": 42.0
        }
      },
      "timestamp": 42.0,
      "transport": {
        "inbound_handling_time_histogram": [
          {}
        ],
        "outbound_handling_time_histogram": [
          {}
        ],
        "rx_count": 42.0,
        "rx_size": "string",
        "rx_size_in_bytes": 42.0,
        "server_open": 42.0,
        "tx_count": 42.0,
        "tx_size": "string",
        "tx_size_in_bytes": 42.0,
        "total_outbound_connections": 42.0
      },
      "transport_address": "string",
      "attributes": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "discovery": {
        "cluster_state_queue": {
          "total": 42.0,
          "pending": 42.0,
          "committed": 42.0
        },
        "published_cluster_states": {
          "full_states": 42.0,
          "incompatible_diffs": 42.0,
          "compatible_diffs": 42.0
        },
        "cluster_state_update": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        },
        "serialized_cluster_states": {
          "full_states": {},
          "diffs": {}
        },
        "cluster_applier_stats": {
          "recordings": [
            {}
          ]
        }
      },
      "indexing_pressure": {
        "memory": {
          "limit_in_bytes": 42.0,
          "current": {},
          "total": {}
        }
      },
      "indices": {
        "commit": {
          "generation": 42.0,
          "id": "string",
          "num_docs": 42.0,
          "user_data": {}
        },
        "completion": {
          "size_in_bytes": 42.0,
          "fields": {}
        },
        "docs": {
          "count": 42.0,
          "deleted": 42.0
        },
        "fielddata": {
          "evictions": 42.0,
          "memory_size_in_bytes": 42.0,
          "fields": {}
        },
        "flush": {
          "periodic": 42.0,
          "total": 42.0,
          "total_time": "string"
        },
        "get": {
          "current": 42.0,
          "exists_time": "string",
          "exists_total": 42.0,
          "missing_time": "string",
          "missing_total": 42.0,
          "time": "string",
          "total": 42.0
        },
        "indexing": {
          "index_current": 42.0,
          "delete_current": 42.0,
          "delete_time": "string",
          "delete_total": 42.0,
          "is_throttled": true,
          "noop_update_total": 42.0,
          "throttle_time": "string",
          "index_time": "string",
          "index_total": 42.0,
          "index_failed": 42.0,
          "types": {},
          "write_load": 42.0
        },
        "mappings": {
          "total_count": 42.0,
          "total_estimated_overhead_in_bytes": 42.0
        },
        "merges": {
          "current": 42.0,
          "current_docs": 42.0,
          "current_size": "string",
          "current_size_in_bytes": 42.0,
          "total": 42.0,
          "total_auto_throttle": "string",
          "total_auto_throttle_in_bytes": 42.0,
          "total_docs": 42.0,
          "total_size": "string",
          "total_size_in_bytes": 42.0,
          "total_stopped_time": "string",
          "total_throttled_time": "string",
          "total_time": "string"
        },
        "shard_path": {
          "data_path": "string",
          "is_custom_data_path": true,
          "state_path": "string"
        },
        "query_cache": {
          "cache_count": 42.0,
          "cache_size": 42.0,
          "evictions": 42.0,
          "hit_count": 42.0,
          "memory_size_in_bytes": 42.0,
          "miss_count": 42.0,
          "total_count": 42.0
        },
        "recovery": {
          "current_as_source": 42.0,
          "current_as_target": 42.0,
          "throttle_time": "string"
        },
        "refresh": {
          "external_total": 42.0,
          "listeners": 42.0,
          "total": 42.0,
          "total_time": "string"
        },
        "request_cache": {
          "evictions": 42.0,
          "hit_count": 42.0,
          "memory_size": "string",
          "memory_size_in_bytes": 42.0,
          "miss_count": 42.0
        },
        "retention_leases": {
          "primary_term": 42.0,
          "version": 42.0,
          "leases": [
            {}
          ]
        },
        "routing": {
          "node": "string",
          "primary": true,
          "state": "UNASSIGNED"
        },
        "search": {
          "fetch_current": 42.0,
          "fetch_time": "string",
          "fetch_total": 42.0,
          "open_contexts": 42.0,
          "query_current": 42.0,
          "query_time": "string",
          "query_total": 42.0,
          "scroll_current": 42.0,
          "scroll_time": "string",
          "scroll_total": 42.0,
          "suggest_current": 42.0,
          "suggest_time": "string",
          "suggest_total": 42.0,
          "groups": {}
        },
        "segments": {
          "count": 42.0,
          "doc_values_memory_in_bytes": 42.0,
          "file_sizes": {},
          "fixed_bit_set_memory_in_bytes": 42.0,
          "index_writer_max_memory_in_bytes": 42.0,
          "index_writer_memory_in_bytes": 42.0,
          "max_unsafe_auto_id_timestamp": 42.0,
          "memory_in_bytes": 42.0,
          "norms_memory_in_bytes": 42.0,
          "points_memory_in_bytes": 42.0,
          "stored_fields_memory_in_bytes": 42.0,
          "terms_memory_in_bytes": 42.0,
          "term_vectors_memory_in_bytes": 42.0,
          "version_map_memory_in_bytes": 42.0
        },
        "seq_no": {
          "global_checkpoint": 42.0,
          "local_checkpoint": 42.0,
          "max_seq_no": 42.0
        },
        "store": {
          "size_in_bytes": 42.0,
          "reserved_in_bytes": 42.0,
          "total_data_set_size_in_bytes": 42.0
        },
        "translog": {
          "earliest_last_modified_age": 42.0,
          "operations": 42.0,
          "size": "string",
          "size_in_bytes": 42.0,
          "uncommitted_operations": 42.0,
          "uncommitted_size": "string",
          "uncommitted_size_in_bytes": 42.0
        },
        "warmer": {
          "current": 42.0,
          "total": 42.0,
          "total_time": "string"
        },
        "bulk": {
          "total_operations": 42.0,
          "total_time": "string",
          "total_size_in_bytes": 42.0,
          "avg_time": "string",
          "avg_size_in_bytes": 42.0
        },
        "shards": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        },
        "shard_stats": {
          "total_count": 42.0
        },
        "additionalProperty1": {
          "primaries": {},
          "shards": {},
          "total": {},
          "uuid": "string",
          "health": "green",
          "status": "open"
        },
        "additionalProperty2": {
          "primaries": {},
          "shards": {},
          "total": {},
          "uuid": "string",
          "health": "green",
          "status": "open"
        }
      }
    }
  }
}