Delete an autoscaling policy Generally available; Added in 7.11.0

DELETE /_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.

Values are -1 or 0.
timeout string

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

Values are -1 or 0.

Responses

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

DELETE /_autoscaling/policy/{name}

curl \
 --request DELETE 'http://api.example.com/_autoscaling/policy/{name}' \
 --header "Authorization: $API_KEY"

Response examples (200)

This may be a response to either `DELETE /_autoscaling/policy/my_autoscaling_policy` or `DELETE /_autoscaling/policy/*`.

{
  "acknowledged": true
}

Get the autoscaling capacity Generally available; 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.

Values are -1 or 0.

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: {}
}

Get behavioral analytics collections Technical preview; Added in 8.8.0

GET /_application/analytics/{name}

Api key auth Basic auth Bearer auth

Path parameters

name array[string] Required

A list of analytics collections to limit the returned information

Responses

200 application/json
Hide response attribute Show response attribute object
- * object Additional properties
  
  Hide * attribute Show * attribute object
  
  event_data_stream object Required
  
  Hide event_data_stream attribute Show event_data_stream attribute object
  
  name string Required

GET /_application/analytics/{name}

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

Response examples (200)

A successful response from `GET _application/analytics/my*`

{
  "my_analytics_collection": {
      "event_data_stream": {
          "name": "behavioral_analytics-events-my_analytics_collection"
      }
  },
  "my_analytics_collection2": {
      "event_data_stream": {
          "name": "behavioral_analytics-events-my_analytics_collection2"
      }
  }
}

Create a behavioral analytics collection Technical preview; Added in 8.8.0

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"

Delete a behavioral analytics collection Technical preview; Added in 8.8.0

DELETE /_application/analytics/{name}

Api key auth Basic auth Bearer auth

The associated data stream is also deleted.

Path parameters

name string Required

The name of the analytics collection to be deleted

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.

DELETE /_application/analytics/{name}

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

Get behavioral analytics collections Technical preview; Added in 8.8.0

GET /_application/analytics

Api key auth Basic auth Bearer auth

Responses

200 application/json
Hide response attribute Show response attribute object
- * object Additional properties
  
  Hide * attribute Show * attribute object
  
  event_data_stream object Required
  
  Hide event_data_stream attribute Show event_data_stream attribute object
  
  name string Required

GET /_application/analytics

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

Response examples (200)

A successful response from `GET _application/analytics/my*`

{
  "my_analytics_collection": {
      "event_data_stream": {
          "name": "behavioral_analytics-events-my_analytics_collection"
      }
  },
  "my_analytics_collection2": {
      "event_data_stream": {
          "name": "behavioral_analytics-events-my_analytics_collection2"
      }
  }
}

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

Compact and aligned text (CAT)

The compact and aligned text (CAT) APIs aim are intended only for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, it's recommend to use a corresponding JSON API. All the cat commands accept a query string parameter help to see all the headers and info they provide, and the /_cat command alone lists all the available commands.

Get aliases Generally available

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.

Required authorization

Index privileges: view_index_metadata

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.

Values are all, open, closed, hidden, or none.
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.

Values are -1 or 0.

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 Generally available

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.

Required authorization

Cluster privileges: monitor

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.

Values are -1 or 0.

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 component templates Generally available; Added in 5.1.0

GET /_cat/component_templates

Api key auth Basic auth Bearer auth

Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

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 component template API.

Required authorization

Cluster privileges: monitor

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

The period to wait for a connection to the master node.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- name string Required
- version string | null Required
  
  One of:
  string-1 string string-2 string | null
- alias_count string Required
- mapping_count string Required
- settings_count string Required
- metadata_count string Required
- included_in string Required

GET /_cat/component_templates

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

Response examples (200)

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

[
  {
    "name": "my-template-1",
    "version": "null",
    "alias_count": "0",
    "mapping_count": "0",
    "settings_count": "1",
    "metadata_count": "0",
    "included_in": "[my-index-template]"
  },
    {
    "name": "my-template-2",
    "version": null,
    "alias_count": "0",
    "mapping_count": "3",
    "settings_count": "0",
    "metadata_count": "0",
    "included_in": "[my-index-template]"
  }
]

Get component templates Generally available; Added in 5.1.0

GET /_cat/component_templates/{name}

Api key auth Basic auth Bearer auth

Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

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 component template API.

Required authorization

Cluster privileges: monitor

Path parameters

name string Required

The name of the component template. It accepts wildcard expressions. If it is omitted, all component 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

The period to wait for a connection to the master node.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- name string Required
- version string | null Required
  
  One of:
  string-1 string string-2 string | null
- alias_count string Required
- mapping_count string Required
- settings_count string Required
- metadata_count string Required
- included_in string Required

GET /_cat/component_templates/{name}

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

Response examples (200)

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

[
  {
    "name": "my-template-1",
    "version": "null",
    "alias_count": "0",
    "mapping_count": "0",
    "settings_count": "1",
    "metadata_count": "0",
    "included_in": "[my-index-template]"
  },
    {
    "name": "my-template-2",
    "version": null,
    "alias_count": "0",
    "mapping_count": "3",
    "settings_count": "0",
    "metadata_count": "0",
    "included_in": "[my-index-template]"
  }
]

Get the cluster health status Generally available

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.

Required authorization

Cluster privileges: monitor

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 CAT help Generally available

GET /_cat

Api key auth Basic auth Bearer auth

Get help for the CAT APIs.

Responses

200 application/json

GET /_cat

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

Get master node information Generally available

GET /_cat/master

Api key auth Basic auth Bearer auth

Get information about the master node, including the ID, bound IP address, and name.

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

Required authorization

Cluster privileges: monitor

Query parameters

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.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- id string
  
  node id
- host string
  
  host name
- ip string
  
  ip address
- node string
  
  node name

GET /_cat/master

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

Response examples (200)

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

[
  {
    "id": "YzWoH_2BT-6UjVGDyPdqYg",
    "host": "127.0.0.1",
    "ip": "127.0.0.1",
    "node": "YzWoH_2"
  }
]

Get data frame analytics jobs Generally available; 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.

Required authorization

Cluster privileges: monitor_ml

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 Generally available; 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.

Required authorization

Cluster privileges: monitor_ml

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 anomaly detection jobs Generally available; Added in 7.7.0

GET /_cat/ml/anomaly_detectors

Api key auth Basic auth Bearer auth

Get configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. 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 anomaly detection job statistics API.

Required authorization

Cluster privileges: monitor_ml

Query parameters

allow_no_match boolean
Specifies what to do when the request:
- Contains wildcard expressions and there are no jobs 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 jobs 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.
bytes string

The unit used 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

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
- state string
  
  Values are closing, closed, opened, failed, or opening.
- opened_time string
  
  For open jobs only, the amount of time the job has been opened.
- assignment_explanation string
  
  For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.
- data.processed_records string
  
  The number of input documents that have been processed by the anomaly detection job. This value includes documents with missing fields, since they are nonetheless analyzed. If you use datafeeds and have aggregations in your search query, the processed_record_count is the number of aggregation results processed, not the number of Elasticsearch documents.
- data.processed_fields string
  
  The total number of fields in all the documents that have been processed by the anomaly detection job. Only fields that are specified in the detector configuration object contribute to this count. The timestamp is not included in this count.
- data.input_bytes number | string
  
  One of:
  ByteSize number ByteSize string
- data.input_records string
  
  The number of input documents posted to the anomaly detection job.
- data.input_fields string
  
  The total number of fields in input documents posted to the anomaly detection job. This count includes fields that are not used in the analysis. However, be aware that if you are using a datafeed, it extracts only the required fields from the documents it retrieves before posting them to the job.
- data.invalid_dates string
  
  The number of input documents with either a missing date field or a date that could not be parsed.
- data.missing_fields string
  
  The number of input documents that are missing a field that the anomaly detection job is configured to analyze. Input documents with missing fields are still processed because it is possible that not all fields are missing. If you are using datafeeds or posting data to the job in JSON format, a high missing_field_count is often not an indication of data issues. It is not necessarily a cause for concern.
- data.out_of_order_timestamps string
  
  The number of input documents that have a timestamp chronologically preceding the start of the current anomaly detection bucket offset by the latency window. This information is applicable only when you provide data to the anomaly detection job by using the post data API. These out of order documents are discarded, since jobs require time series data to be in ascending chronological order.
- data.empty_buckets string
  
  The number of buckets which did not contain any data. If your data contains many empty buckets, consider increasing your bucket_span or using functions that are tolerant to gaps in data such as mean, non_null_sum or non_zero_count.
- data.sparse_buckets string
  
  The number of buckets that contained few data points compared to the expected number of data points. If your data contains many sparse buckets, consider using a longer bucket_span.
- data.buckets string
  
  The total number of buckets processed.
- data.earliest_record string
  
  The timestamp of the earliest chronologically input document.
- data.latest_record string
  
  The timestamp of the latest chronologically input document.
- data.last string
  
  The timestamp at which data was last analyzed, according to server time.
- data.last_empty_bucket string
  
  The timestamp of the last bucket that did not contain any data.
- data.last_sparse_bucket string
  
  The timestamp of the last bucket that was considered sparse.
- model.bytes number | string
  
  One of:
  ByteSize number ByteSize string
- model.memory_status string
  
  Values are ok, soft_limit, or hard_limit.
- model.bytes_exceeded number | string
  
  One of:
  ByteSize number ByteSize string
- model.memory_limit string
  
  The upper limit for model memory usage, checked on increasing values.
- model.by_fields string
  
  The number of by field values that were analyzed by the models. This value is cumulative for all detectors in the job.
- model.over_fields string
  
  The number of over field values that were analyzed by the models. This value is cumulative for all detectors in the job.
- model.partition_fields string
  
  The number of partition field values that were analyzed by the models. This value is cumulative for all detectors in the job.
- model.bucket_allocation_failures string
  
  The number of buckets for which new entities in incoming data were not processed due to insufficient model memory. This situation is also signified by a hard_limit: memory_status property value.
- model.categorization_status string
  
  Values are ok or warn.
- model.categorized_doc_count string
  
  The number of documents that have had a field categorized.
- model.total_category_count string
  
  The number of categories created by categorization.
- model.frequent_category_count string
  
  The number of categories that match more than 1% of categorized documents.
- model.rare_category_count string
  
  The number of categories that match just one categorized document.
- model.dead_category_count string
  
  The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category. Dead categories are a side effect of the way categorization has no prior training.
- model.failed_category_count string
  
  The number of times that categorization wanted to create a new category but couldn’t because the job had hit its model_memory_limit. This count does not track which specific categories failed to be created. Therefore you cannot use this value to determine the number of unique categories that were missed.
- model.log_time string
  
  The timestamp when the model stats were gathered, according to server time.
- model.timestamp string
  
  The timestamp of the last record when the model stats were gathered.
- forecasts.total string
  
  The number of individual forecasts currently available for the job. A value of one or more indicates that forecasts exist.
- forecasts.memory.min string
  
  The minimum memory usage in bytes for forecasts related to the anomaly detection job.
- forecasts.memory.max string
  
  The maximum memory usage in bytes for forecasts related to the anomaly detection job.
- forecasts.memory.avg string
  
  The average memory usage in bytes for forecasts related to the anomaly detection job.
- forecasts.memory.total string
  
  The total memory usage in bytes for forecasts related to the anomaly detection job.
- forecasts.records.min string
  
  The minimum number of model_forecast documents written for forecasts related to the anomaly detection job.
- forecasts.records.max string
  
  The maximum number of model_forecast documents written for forecasts related to the anomaly detection job.
- forecasts.records.avg string
  
  The average number of model_forecast documents written for forecasts related to the anomaly detection job.
- forecasts.records.total string
  
  The total number of model_forecast documents written for forecasts related to the anomaly detection job.
- forecasts.time.min string
  
  The minimum runtime in milliseconds for forecasts related to the anomaly detection job.
- forecasts.time.max string
  
  The maximum runtime in milliseconds for forecasts related to the anomaly detection job.
- forecasts.time.avg string
  
  The average runtime in milliseconds for forecasts related to the anomaly detection job.
- forecasts.time.total string
  
  The total runtime in milliseconds for forecasts related to the anomaly detection job.
- node.id string
- node.name string
  
  The name of the assigned node.
- node.ephemeral_id string
- node.address string
  
  The network address of the assigned node.
- buckets.count string
  
  The number of bucket results produced by the job.
- buckets.time.total string
  
  The sum of all bucket processing times, in milliseconds.
- buckets.time.min string
  
  The minimum of all bucket processing times, in milliseconds.
- buckets.time.max string
  
  The maximum of all bucket processing times, in milliseconds.
- buckets.time.exp_avg string
  
  The exponential moving average of all bucket processing times, in milliseconds.
- buckets.time.exp_avg_hour string
  
  The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds.

GET /_cat/ml/anomaly_detectors

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

Response examples (200)

A successful response from `GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json`.

[
  {
    "id": "high_sum_total_sales",
    "s": "closed",
    "dpr": "14022",
    "mb": "1.5mb"
  },
  {
    "id": "low_request_rate",
    "s": "closed",
    "dpr": "1216",
    "mb": "40.5kb"
  },
  {
    "id": "response_code_rates",
    "s": "closed",
    "dpr": "28146",
    "mb": "132.7kb"
  },
  {
    "id": "url_scanning",
    "s": "closed",
    "dpr": "28146",
    "mb": "501.6kb"
  }
]

Get node attribute information Generally available

GET /_cat/nodeattrs

Api key auth Basic auth Bearer auth

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

Required authorization

Cluster privileges: monitor

Query parameters

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.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- node string
  
  The node name.
- id string
  
  The unique node identifier.
- pid string
  
  The process identifier.
- host string
  
  The host name.
- ip string
  
  The IP address.
- port string
  
  The bound transport port.
- attr string
  
  The attribute name.
- value string
  
  The attribute value.

GET /_cat/nodeattrs

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

Response examples (200)

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

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

A successful response from `GET /_cat/nodeattrs?v=true&h=name,pid,attr,value`. It returns the `name`, `pid`, `attr`, and `value` columns.

[
  {
    "name": "node-0",
    "pid": "19566",
    "attr": "testattr",
    "value": "test"
  }
]

Get shard recovery information Generally available

GET /_cat/recovery

Api key auth Basic auth Bearer auth

Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. 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 index recovery API.

Required authorization

Index privileges: monitor
Cluster privileges: monitor

Query parameters

active_only boolean

If true, the response only includes ongoing shard recoveries.
bytes string

The unit used to display byte values.

Values are b, kb, mb, gb, tb, or pb.
detailed boolean

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

Comma-separated list or wildcard expression of index names to limit the returned information
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.

Responses

200 application/json
Hide response attributes Show response attributes object
- index string
- shard string
  
  The shard name.
- start_time string | number
  
  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
- start_time_millis number
  
  Time unit for milliseconds
- stop_time string | number
  
  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
- stop_time_millis number
  
  Time unit for milliseconds
- 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.
- type string
  
  The recovery type.
- stage string
  
  The recovery stage.
- source_host string
  
  The source host.
- source_node string
  
  The source node name.
- target_host string
  
  The target host.
- target_node string
  
  The target node name.
- repository string
  
  The repository name.
- snapshot string
  
  The snapshot name.
- files string
  
  The number of files to recover.
- files_recovered string
  
  The files recovered.
- files_percent string | number
  
  One of:
  Percentage string Percentage number
- files_total string
  
  The total number of files.
- bytes string
  
  The number of bytes to recover.
- bytes_recovered string
  
  The bytes recovered.
- bytes_percent string | number
  
  One of:
  Percentage string Percentage number
- bytes_total string
  
  The total number of bytes.
- translog_ops string
  
  The number of translog operations to recover.
- translog_ops_recovered string
  
  The translog operations recovered.
- translog_ops_percent string | number
  
  One of:
  Percentage string Percentage number

GET /_cat/recovery

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

Response examples (200)

A successful response from `GET _cat/recovery?v=true&format=json`. In this example, the source and target nodes are the same because the recovery type is `store`, meaning they were read from local storage on node start.

[
  {
    "index": "my-index-000001 ",
    "shard": "0",
    "time": "13ms",
    "type": "store",
    "stage": "done",
    "source_host": "n/a",
    "source_node": "n/a",
    "target_host": "127.0.0.1",
    "target_node": "node-0",
    "repository": "n/a",
    "snapshot": "n/a",
    "files": "0",
    "files_recovered": "0",
    "files_percent": "100.0%",
    "files_total": "13",
    "bytes": "0b",
    "bytes_recovered": "0b",
    "bytes_percent": "100.0%",
    "bytes_total": "9928b",
    "translog_ops": "0",
    "translog_ops_recovered": "0",
    "translog_ops_percent": "100.0%"
  }
]

A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp&format=json`. You can retrieve information about an ongoing recovery for example when you increase the replica count of an index and bring another node online to host the replicas. In this example, the recovery type is `peer`, meaning the shard recovered from another node. The `files` and `bytes` are real-time measurements.

[
  {
    "i": "my-index-000001",
    "s": "0",
    "t": "1252ms",
    "ty": "peer",
    "st": "done",
    "shost": "192.168.1.1",
    "thost": "192.168.1.1",
    "f": "0",
    "fp": "100.0%",
    "b": "0b",
    "bp": "100.0%",
  }
]

A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp&format=json`. You can restore backups of an index using the snapshot and restore API. You can use the cat recovery API to get information about a snapshot recovery.

[
  {
    "i": "my-index-000001",
    "s": "0",
    "t": "1978ms",
    "ty": "snapshot",
    "st": "done",
    "rep": "my-repo",
    "snap": "snap-1",
    "f": "79",
    "fp": "8.0%",
    "b": "12086",
    "bp": "9.0%"
  }
]

Get shard recovery information Generally available

GET /_cat/recovery/{index}

Api key auth Basic auth Bearer auth

Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. 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 index recovery API.

Required authorization

Index privileges: monitor
Cluster privileges: monitor

Path parameters

index string | array[string] Required

A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Query parameters

active_only boolean

If true, the response only includes ongoing shard recoveries.
bytes string

The unit used to display byte values.

Values are b, kb, mb, gb, tb, or pb.
detailed boolean

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

Comma-separated list or wildcard expression of index names to limit the returned information
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.

Responses

200 application/json
Hide response attributes Show response attributes object
- index string
- shard string
  
  The shard name.
- start_time string | number
  
  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
- start_time_millis number
  
  Time unit for milliseconds
- stop_time string | number
  
  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
- stop_time_millis number
  
  Time unit for milliseconds
- 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.
- type string
  
  The recovery type.
- stage string
  
  The recovery stage.
- source_host string
  
  The source host.
- source_node string
  
  The source node name.
- target_host string
  
  The target host.
- target_node string
  
  The target node name.
- repository string
  
  The repository name.
- snapshot string
  
  The snapshot name.
- files string
  
  The number of files to recover.
- files_recovered string
  
  The files recovered.
- files_percent string | number
  
  One of:
  Percentage string Percentage number
- files_total string
  
  The total number of files.
- bytes string
  
  The number of bytes to recover.
- bytes_recovered string
  
  The bytes recovered.
- bytes_percent string | number
  
  One of:
  Percentage string Percentage number
- bytes_total string
  
  The total number of bytes.
- translog_ops string
  
  The number of translog operations to recover.
- translog_ops_recovered string
  
  The translog operations recovered.
- translog_ops_percent string | number
  
  One of:
  Percentage string Percentage number

GET /_cat/recovery/{index}

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

Response examples (200)

A successful response from `GET _cat/recovery?v=true&format=json`. In this example, the source and target nodes are the same because the recovery type is `store`, meaning they were read from local storage on node start.

[
  {
    "index": "my-index-000001 ",
    "shard": "0",
    "time": "13ms",
    "type": "store",
    "stage": "done",
    "source_host": "n/a",
    "source_node": "n/a",
    "target_host": "127.0.0.1",
    "target_node": "node-0",
    "repository": "n/a",
    "snapshot": "n/a",
    "files": "0",
    "files_recovered": "0",
    "files_percent": "100.0%",
    "files_total": "13",
    "bytes": "0b",
    "bytes_recovered": "0b",
    "bytes_percent": "100.0%",
    "bytes_total": "9928b",
    "translog_ops": "0",
    "translog_ops_recovered": "0",
    "translog_ops_percent": "100.0%"
  }
]

A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp&format=json`. You can retrieve information about an ongoing recovery for example when you increase the replica count of an index and bring another node online to host the replicas. In this example, the recovery type is `peer`, meaning the shard recovered from another node. The `files` and `bytes` are real-time measurements.

[
  {
    "i": "my-index-000001",
    "s": "0",
    "t": "1252ms",
    "ty": "peer",
    "st": "done",
    "shost": "192.168.1.1",
    "thost": "192.168.1.1",
    "f": "0",
    "fp": "100.0%",
    "b": "0b",
    "bp": "100.0%",
  }
]

A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp&format=json`. You can restore backups of an index using the snapshot and restore API. You can use the cat recovery API to get information about a snapshot recovery.

[
  {
    "i": "my-index-000001",
    "s": "0",
    "t": "1978ms",
    "ty": "snapshot",
    "st": "done",
    "rep": "my-repo",
    "snap": "snap-1",
    "f": "79",
    "fp": "8.0%",
    "b": "12086",
    "bp": "9.0%"
  }
]

Get segment information Generally available

GET /_cat/segments/{index}

Api key auth Basic auth Bearer auth

Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. 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 index segments API.

Required authorization

Index privileges: monitor
Cluster privileges: monitor

Path parameters

index string | array[string] Required

A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

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.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- index string
- shard string
  
  The shard name.
- prirep string
  
  The shard type: primary or replica.
- ip string
  
  The IP address of the node where it lives.
- id string
- segment string
  
  The segment name, which is derived from the segment generation and used internally to create file names in the directory of the shard.
- generation string
  
  The segment generation number. Elasticsearch increments this generation number for each segment written then uses this number to derive the segment name.
- docs.count string
  
  The number of documents in the segment. This excludes deleted documents and counts any nested documents separately from their parents. It also excludes documents which were indexed recently and do not yet belong to a segment.
- docs.deleted string
  
  The number of deleted documents in the segment, which might be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. Also, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard.
- size number | string
  
  One of:
  ByteSize number ByteSize string
- size.memory number | string
  
  One of:
  ByteSize number ByteSize string
- committed string
  
  If true, the segment is synced to disk. Segments that are synced can survive a hard reboot. If false, the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start.
- searchable string
  
  If true, the segment is searchable. If false, the segment has most likely been written to disk but needs a refresh to be searchable.
- version string
- compound string
  
  If true, the segment is stored in a compound file. This means Lucene merged all files from the segment in a single file to save file descriptors.

GET /_cat/segments/{index}

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

Response examples (200)

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

[
  {
    "index": "test",
    "shard": "0",
    "prirep": "p",
    "ip": "127.0.0.1",
    "segment": "_0",
    "generation": "0",
    "docs.count": "1",
    "docs.deleted": "0",
    "size": "3kb",
    "size.memory": "0",
    "committed": "false",
    "searchable": "true",
    "version": "9.12.0",
    "compound": "true"
  },
  {
    "index": "test1",
    "shard": "0",
    "prirep": "p",
    "ip": "127.0.0.1",
    "segment": "_0",
    "generation": "0",
    "docs.count": "1",
    "docs.deleted": "0",
    "size": "3kb",
    "size.memory": "0",
    "committed": "false",
    "searchable": "true",
    "version": "9.12.0",
    "compound": "true"
  }
]

Get snapshot information Generally available; Added in 2.1.0

GET /_cat/snapshots

Api key auth Basic auth Bearer auth

Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch 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 get snapshot API.

Required authorization

Cluster privileges: monitor_snapshot

Query parameters

ignore_unavailable boolean

If true, the response does not include information from unavailable snapshots.
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.

Values are -1 or 0.
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
  
  The unique identifier for the snapshot.
- repository string
  
  The repository name.
- status string
  
  The state of the snapshot process. Returned values include: FAILED: The snapshot process failed. INCOMPATIBLE: The snapshot process is incompatible with the current cluster version. IN_PROGRESS: The snapshot process started but has not completed. PARTIAL: The snapshot process completed with a partial success. SUCCESS: The snapshot process completed with a full success.
- start_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
- start_time string | object
  
  A time of day, expressed either as hh:mm, noon, midnight, or an hour/minutes structure.
  
  One of:
  ScheduleTimeOfDay string HourAndMinute object
- end_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
- end_time string
  
  Time of day, expressed as HH:MM:SS
- duration 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.
- indices string
  
  The number of indices in the snapshot.
- successful_shards string
  
  The number of successful shards in the snapshot.
- failed_shards string
  
  The number of failed shards in the snapshot.
- total_shards string
  
  The total number of shards in the snapshot.
- reason string
  
  The reason for any snapshot failures.

GET /_cat/snapshots

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

Response examples (200)

A successful response from `GET /_cat/snapshots/repo1?v=true&s=id&format=json`.

[
  {
    "id": "snap1",
    "repository": "repo1",
    "status": "FAILED",
    "start_epoch": "1445616705",
    "start_time": "18:11:45",
    "end_epoch": "1445616978",
    "end_time": "18:16:18",
    "duration": "4.6m",
    "indices": "1",
    "successful_shards": "4",
    "failed_shards": "1",
    "total_shards": "5"
  },
  {
    "id": "snap2",
    "repository": "repo1",
    "status": "SUCCESS",
    "start_epoch": "1445634298",
    "start_time": "23:04:58",
    "end_epoch": "1445634672",
    "end_time": "23:11:12",
    "duration": "6.2m",
    "indices": "2",
    "successful_shards": "10",
    "failed_shards": "0",
    "total_shards": "10"
  }
]

Get task information Technical preview; Added in 5.0.0

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.

Required authorization

Cluster privileges: monitor

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.

Values are -1 or 0.
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 thread pool statistics Generally available

GET /_cat/thread_pool

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.

Required authorization

Cluster privileges: monitor

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.

Values are -1 or 0.

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

curl \
 --request GET 'http://api.example.com/_cat/thread_pool' \
 --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"
  }
]

Explain the shard allocations Generally available; Added in 5.0.0

GET /_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.

Values are -1 or 0.

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
  
  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
  
  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 Generally available; Added in 7.14.0

GET /_cluster/allocation/explain

curl \
 --request GET '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]]]"
        }
      ]
    }
  ]
}

Clear cluster voting config exclusions Generally available; Added in 7.0.0

DELETE /_cluster/voting_config_exclusions

Api key auth Basic auth Bearer auth

Remove master-eligible nodes from the voting configuration exclusion list.

External documentation

Query parameters

master_timeout string

Period to wait for a connection to the master node.

Values are -1 or 0.
wait_for_removal boolean

Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to false then the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster.

Responses

200 application/json

DELETE /_cluster/voting_config_exclusions

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

Get cluster info Generally available; Added in 8.9.0

GET /_info/{target}

Api key auth Basic auth Bearer auth

Returns basic information about the cluster.

Path parameters

target string | array[string] Required

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

Values are _all, http, ingest, thread_pool, or script.

Responses

200 application/json
Hide response attributes Show response attributes object
- cluster_name string Required
- 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.
  
  Hide clients attributes Show clients attributes object
  
  id number
  
  Unique ID for the HTTP client.
  
  agent string
  
  Reported agent for the HTTP client. If unavailable, this property is not included in the response.
  
  local_address string
  
  Local address for the HTTP connection.
  
  remote_address string
  
  Remote address for the HTTP connection.
  
  last_uri string
  
  The URI of the client’s most recent request.
  
  opened_time_millis number
  
  Time at which the client opened the connection.
  
  closed_time_millis number
  
  Time at which the client closed the connection if the connection is closed.
  
  last_request_time_millis number
  
  Time of the most recent request from this client.
  
  request_count number
  
  Number of requests from this client.
  
  request_size_bytes number
  
  Cumulative size in bytes of all requests from this client.
  
  x_opaque_id string
  
  Value from the client’s x-opaque-id HTTP header. If unavailable, this property is not included in the response.
  
  routes object Required Generally available; Added in 8.12.0
  
  Detailed HTTP stats broken down by route
  
  Hide routes attribute Show routes attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  requests object Required
  
  Hide requests attributes Show requests attributes object
  
  count number Required
  
  total_size_in_bytes number Required
  
  size_histogram array[object] Required
  
  responses object Required
  
  Hide responses attributes Show responses attributes object
  
  count number Required
  
  total_size_in_bytes number Required
  
  handling_time_histogram array[object] Required
  
  size_histogram array[object] Required
- 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
  
  Hide * attributes Show * 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.
  
  processors array[object] Required
  
  Total number of ingest processors.
  
  Hide processors attribute Show processors attribute object
  
  * object Additional properties
  
  time_in_millis number
  
  Time unit for milliseconds
  
  ingested_as_first_pipeline_in_bytes number Required Generally available; Added in 8.15.0
  
  Total number of bytes of all documents ingested by the pipeline. This field is only present on pipelines which are the first to process a document. Thus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors.
  
  produced_as_first_pipeline_in_bytes number Required Generally available; Added in 8.15.0
  
  Total number of bytes of all documents produced by the pipeline. This field is only present on pipelines which are the first to process a document. Thus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors. In situations where there are subsequent pipelines, the value represents the size of the document after all pipelines have run.
  
  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.
  
  time_in_millis number
  
  Time unit for milliseconds
- thread_pool object
  
  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.
- 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]
  
  Hide contexts attributes Show contexts attributes object
  
  context string
  
  compilations number
  
  cache_evictions number
  
  compilation_limit_triggered number

GET /_info/{target}

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

Get the pending cluster tasks Generally available

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.

Required authorization

Cluster privileges: monitor

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.

Values are -1 or 0.

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"

Get remote cluster information Generally available; 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.

Required authorization

Cluster privileges: monitor

External documentation

Responses

200 application/json

GET /_remote/info

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

Get the cluster state Generally available; Added in 1.3.0

GET /_cluster/state/{metric}/{index}

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.

Required authorization

Cluster privileges: monitor,manage

Path parameters

metric string | array[string] Required

Limit the information returned to the specified metrics
index string | array[string] Required

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

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.

Values are all, open, closed, hidden, or none.
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

Values are -1 or 0.
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

Values are -1 or 0.

Responses

200 application/json

GET /_cluster/state/{metric}/{index}

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

Get cluster statistics Generally available; 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).

Required authorization

Cluster privileges: monitor

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.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Contains statistics about the number of nodes selected by the request.
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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
  
  Contains statistics about shards assigned to selected nodes.
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.16.0
  
  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.
- ccs object Required
  
  Hide ccs attributes Show ccs attributes object
  
  clusters object
  
  Contains remote cluster settings and metrics collected from them. The keys are cluster names, and the values are per-cluster data. Only present if include_remotes option is set to true.
  
  Hide clusters attribute Show clusters attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  cluster_uuid string Required
  
  The UUID of the remote cluster.
  
  mode string Required
  
  The connection mode used to communicate with the remote cluster.
  
  skip_unavailable boolean Required
  
  The skip_unavailable setting used for this remote cluster.
  
  transport_compress string Required
  
  Transport compression setting used for this remote cluster.
  
  status string Required
  
  Values are green, GREEN, yellow, YELLOW, red, or RED.
  
  version array[string] Required
  
  The list of Elasticsearch versions used by the nodes on the remote cluster.
  
  nodes_count number Required
  
  The total count of nodes in the remote cluster.
  
  shards_count number Required
  
  The total number of shards in the remote cluster.
  
  indices_count number Required
  
  The total number of indices in the remote cluster.
  
  indices_total_size_in_bytes number Required
  
  Total data set size, in bytes, of all shards assigned to selected nodes.
  
  indices_total_size string
  
  Total data set size of all shards assigned to selected nodes, as a human-readable string.
  
  max_heap_in_bytes number Required
  
  Maximum amount of memory, in bytes, available for use by the heap across the nodes of the remote cluster.
  
  max_heap string
  
  Maximum amount of memory available for use by the heap across the nodes of the remote cluster, as a human-readable string.
  
  mem_total_in_bytes number Required
  
  Total amount, in bytes, of physical memory across the nodes of the remote cluster.
  
  mem_total string
  
  Total amount of physical memory across the nodes of the remote cluster, as a human-readable string.
  
  _search object Required
  
  Hide _search attributes Show _search attributes object
  
  total number Required
  
  The total number of cross-cluster search requests that have been executed by the cluster.
  
  success number Required
  
  The total number of cross-cluster search requests that have been successfully executed by the cluster.
  
  skipped number Required
  
  The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped.
  
  took object Required
  
  Hide took attributes Show took attributes object
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  took_mrt_true object
  
  Hide took_mrt_true attributes Show took_mrt_true attributes object
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  took_mrt_false object
  
  Hide took_mrt_false attributes Show took_mrt_false attributes object
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  remotes_per_search_max number Required
  
  The maximum number of remote clusters that were queried in a single cross-cluster search request.
  
  remotes_per_search_avg number Required
  
  The average number of remote clusters that were queried in a single cross-cluster search request.
  
  failure_reasons object Required
  
  Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason.
  
  Hide failure_reasons attribute Show failure_reasons attribute object
  
  * number Additional properties
  
  features object Required
  
  The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both async and wildcard).
  
  Hide features attribute Show features attribute object
  
  * number Additional properties
  
  clients object Required
  
  Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as kibana or elasticsearch) are counted.
  
  Hide clients attribute Show clients attribute object
  
  * number Additional properties
  
  clusters object Required
  
  Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name (local).
  
  Hide clusters attribute Show clusters attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  total number Required
  
  The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely.
  
  skipped number Required
  
  The total number of cross-cluster search requests for which this cluster was skipped.
  
  took object Required
  
  _esql object
  
  Hide _esql attributes Show _esql attributes object
  
  total number Required
  
  The total number of cross-cluster search requests that have been executed by the cluster.
  
  success number Required
  
  The total number of cross-cluster search requests that have been successfully executed by the cluster.
  
  skipped number Required
  
  The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped.
  
  took object Required
  
  Hide took attributes Show took attributes object
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  took_mrt_true object
  
  Hide took_mrt_true attributes Show took_mrt_true attributes object
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  took_mrt_false object
  
  Hide took_mrt_false attributes Show took_mrt_false attributes object
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  remotes_per_search_max number Required
  
  The maximum number of remote clusters that were queried in a single cross-cluster search request.
  
  remotes_per_search_avg number Required
  
  The average number of remote clusters that were queried in a single cross-cluster search request.
  
  failure_reasons object Required
  
  Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason.
  
  Hide failure_reasons attribute Show failure_reasons attribute object
  
  * number Additional properties
  
  features object Required
  
  The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both async and wildcard).
  
  Hide features attribute Show features attribute object
  
  * number Additional properties
  
  clients object Required
  
  Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as kibana or elasticsearch) are counted.
  
  Hide clients attribute Show clients attribute object
  
  * number Additional properties
  
  clusters object Required
  
  Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name (local).
  
  Hide clusters attribute Show clusters attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  total number Required
  
  The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely.
  
  skipped number Required
  
  The total number of cross-cluster search requests for which this cluster was skipped.
  
  took object Required

GET /_cluster/stats

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

Get cluster statistics Generally available; 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).

Required authorization

Cluster privileges: monitor

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.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Contains statistics about the number of nodes selected by the request.
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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
  
  Contains statistics about shards assigned to selected nodes.
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.13.0
  
  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 Generally available; Added in 7.16.0
  
  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.
- ccs object Required
  
  Hide ccs attributes Show ccs attributes object
  
  clusters object
  
  Contains remote cluster settings and metrics collected from them. The keys are cluster names, and the values are per-cluster data. Only present if include_remotes option is set to true.
  
  Hide clusters attribute Show clusters attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  cluster_uuid string Required
  
  The UUID of the remote cluster.
  
  mode string Required
  
  The connection mode used to communicate with the remote cluster.
  
  skip_unavailable boolean Required
  
  The skip_unavailable setting used for this remote cluster.
  
  transport_compress string Required
  
  Transport compression setting used for this remote cluster.
  
  status string Required
  
  Values are green, GREEN, yellow, YELLOW, red, or RED.
  
  version array[string] Required
  
  The list of Elasticsearch versions used by the nodes on the remote cluster.
  
  nodes_count number Required
  
  The total count of nodes in the remote cluster.
  
  shards_count number Required
  
  The total number of shards in the remote cluster.
  
  indices_count number Required
  
  The total number of indices in the remote cluster.
  
  indices_total_size_in_bytes number Required
  
  Total data set size, in bytes, of all shards assigned to selected nodes.
  
  indices_total_size string
  
  Total data set size of all shards assigned to selected nodes, as a human-readable string.
  
  max_heap_in_bytes number Required
  
  Maximum amount of memory, in bytes, available for use by the heap across the nodes of the remote cluster.
  
  max_heap string
  
  Maximum amount of memory available for use by the heap across the nodes of the remote cluster, as a human-readable string.
  
  mem_total_in_bytes number Required
  
  Total amount, in bytes, of physical memory across the nodes of the remote cluster.
  
  mem_total string
  
  Total amount of physical memory across the nodes of the remote cluster, as a human-readable string.
  
  _search object Required
  
  Hide _search attributes Show _search attributes object
  
  total number Required
  
  The total number of cross-cluster search requests that have been executed by the cluster.
  
  success number Required
  
  The total number of cross-cluster search requests that have been successfully executed by the cluster.
  
  skipped number Required
  
  The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped.
  
  took object Required
  
  Hide took attributes Show took attributes object
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  took_mrt_true object
  
  Hide took_mrt_true attributes Show took_mrt_true attributes object
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  took_mrt_false object
  
  Hide took_mrt_false attributes Show took_mrt_false attributes object
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  remotes_per_search_max number Required
  
  The maximum number of remote clusters that were queried in a single cross-cluster search request.
  
  remotes_per_search_avg number Required
  
  The average number of remote clusters that were queried in a single cross-cluster search request.
  
  failure_reasons object Required
  
  Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason.
  
  Hide failure_reasons attribute Show failure_reasons attribute object
  
  * number Additional properties
  
  features object Required
  
  The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both async and wildcard).
  
  Hide features attribute Show features attribute object
  
  * number Additional properties
  
  clients object Required
  
  Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as kibana or elasticsearch) are counted.
  
  Hide clients attribute Show clients attribute object
  
  * number Additional properties
  
  clusters object Required
  
  Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name (local).
  
  Hide clusters attribute Show clusters attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  total number Required
  
  The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely.
  
  skipped number Required
  
  The total number of cross-cluster search requests for which this cluster was skipped.
  
  took object Required
  
  _esql object
  
  Hide _esql attributes Show _esql attributes object
  
  total number Required
  
  The total number of cross-cluster search requests that have been executed by the cluster.
  
  success number Required
  
  The total number of cross-cluster search requests that have been successfully executed by the cluster.
  
  skipped number Required
  
  The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped.
  
  took object Required
  
  Hide took attributes Show took attributes object
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  took_mrt_true object
  
  Hide took_mrt_true attributes Show took_mrt_true attributes object
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  took_mrt_false object
  
  Hide took_mrt_false attributes Show took_mrt_false attributes object
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  remotes_per_search_max number Required
  
  The maximum number of remote clusters that were queried in a single cross-cluster search request.
  
  remotes_per_search_avg number Required
  
  The average number of remote clusters that were queried in a single cross-cluster search request.
  
  failure_reasons object Required
  
  Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason.
  
  Hide failure_reasons attribute Show failure_reasons attribute object
  
  * number Additional properties
  
  features object Required
  
  The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both async and wildcard).
  
  Hide features attribute Show features attribute object
  
  * number Additional properties
  
  clients object Required
  
  Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as kibana or elasticsearch) are counted.
  
  Hide clients attribute Show clients attribute object
  
  * number Additional properties
  
  clusters object Required
  
  Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name (local).
  
  Hide clusters attribute Show clusters attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  total number Required
  
  The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely.
  
  skipped number Required
  
  The total number of cross-cluster search requests for which this cluster was skipped.
  
  took object Required

GET /_cluster/stats/nodes/{node_id}

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

Clear the archived repositories metering Technical preview; Added in 7.16.0

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.

Required authorization

Cluster privileges: monitor,manage

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
  
  Contains statistics about the number of nodes selected by the request.
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  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"

Get cluster repositories metering Technical preview; Added in 7.16.0

GET /_nodes/{node_id}/_repositories_metering

Api key auth Basic auth Bearer auth

Get repositories metering information for a cluster. This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.

Required authorization

Cluster privileges: monitor,manage

Path parameters

node_id string | array[string] Required

Comma-separated list of node IDs or names used to limit returned information. For more information about the nodes selective options, refer to the node specification documentation.

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Contains statistics about the number of nodes selected by the request.
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  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)

GET /_nodes/{node_id}/_repositories_metering

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

Get the hot threads for nodes Generally available

GET /_nodes/hot_threads

Api key auth Basic auth Bearer auth

Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node.

Required authorization

Cluster privileges: monitor,manage

Query parameters

ignore_idle_threads boolean

If true, known idle threads (e.g. waiting in a socket select, or to get a task from an empty queue) are filtered out.
interval string

The interval to do the second sampling of threads.

Values are -1 or 0.
snapshots number

Number of samples of thread stacktrace.
threads number

Specifies the number of hot threads to provide information for.
timeout string

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

Values are -1 or 0.
type string

The type to sample.

Values are cpu, wait, block, gpu, or mem.
sort string

The sort order for 'cpu' type (default: total)

Values are cpu, wait, block, gpu, or mem.

Responses

200 application/json

GET /_nodes/hot_threads

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

Get node information Generally available; 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.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Contains statistics about the number of nodes selected by the request.
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  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
  
  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 Generally available; 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.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Contains statistics about the number of nodes selected by the request.
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  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
  
  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 Generally available; 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.

Values are -1 or 0.

application/json

Body

secure_settings_password string

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Contains statistics about the number of nodes selected by the request.
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  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
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide reload_exception attributes Show reload_exception attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

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

Reload the keystore on nodes in the cluster Generally available; Added in 6.5.0

POST /_nodes/{node_id}/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.

Path parameters

node_id string | array[string] Required

The names of particular nodes in the cluster to target.

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.

Values are -1 or 0.

application/json

Body

secure_settings_password string

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Contains statistics about the number of nodes selected by the request.
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  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
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide reload_exception attributes Show reload_exception attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

POST /_nodes/{node_id}/reload_secure_settings

curl \
 --request POST 'http://api.example.com/_nodes/{node_id}/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 node statistics Generally available

GET /_nodes/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.

Required authorization

Cluster privileges: monitor,manage

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.

Values are -1 or 0.
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
  
  Contains statistics about the number of nodes selected by the request.
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  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 Generally available; 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]
  
  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 Generally available; Added in 7.15.0
  
  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/stats

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

Get node statistics Generally available

GET /_nodes/{node_id}/stats/{metric}/{index_metric}

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.

Required authorization

Cluster privileges: monitor,manage

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

Limit the information returned to the specified metrics
index_metric string | array[string] Required

Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.

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.

Values are -1 or 0.
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
  
  Contains statistics about the number of nodes selected by the request.
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  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 Generally available; 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]
  
  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 Generally available; Added in 7.15.0
  
  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/{metric}/{index_metric}

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

Get feature usage information Generally available; Added in 6.0.0

GET /_nodes/usage

Api key auth Basic auth Bearer auth

Required authorization

Cluster privileges: monitor,manage

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.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Contains statistics about the number of nodes selected by the request.
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  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
  
  rest_actions object Required
  
  Hide rest_actions attribute Show rest_actions attribute object
  
  * number Additional properties
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  aggregations object Required
  
  Hide aggregations attribute Show aggregations attribute object
  
  * object Additional properties

GET /_nodes/usage

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

Get feature usage information Generally available; Added in 6.0.0

GET /_nodes/{node_id}/usage

Api key auth Basic auth Bearer auth

Required authorization

Cluster privileges: monitor,manage

Path parameters

node_id string | array[string] Required

A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes

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.

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodes object
  
  Contains statistics about the number of nodes selected by the request.
  
  Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  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
  
  rest_actions object Required
  
  Hide rest_actions attribute Show rest_actions attribute object
  
  * number Additional properties
  
  Time unit for milliseconds
  
  Time unit for milliseconds
  
  aggregations object Required
  
  Hide aggregations attribute Show aggregations attribute object
  
  * object Additional properties

GET /_nodes/{node_id}/usage

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

Get the cluster health Generally available; Added in 8.7.0

GET /_health_report

Api key auth Basic auth Bearer auth

Get a report with the health status of an Elasticsearch cluster. The report contains a list of indicators that compose Elasticsearch functionality.

Each indicator has a health status of: green, unknown, yellow or red. The indicator will provide an explanation and metadata describing the reason for its current health status.

The cluster’s status is controlled by the worst indicator status.

In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system.

Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. The root cause and remediation steps are encapsulated in a diagnosis. A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem.

NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.

Query parameters

timeout string

Explicit operation timeout.

Values are -1 or 0.
verbose boolean

Opt-in for more information about the health of the system.
size number

Limit the number of affected resources the health report API returns.

Responses

200 application/json
Hide response attributes Show response attributes object
- cluster_name string Required
- indicators object Required
  
  Hide indicators attributes Show indicators attributes object
  
  master_is_stable object
  
  MASTER_IS_STABLE
  
  Hide master_is_stable attributes Show master_is_stable attributes object
  
  status string Required
  
  Values are green, yellow, red, or unknown.
  
  symptom string Required
  
  impacts array[object]
  
  Hide impacts attributes Show impacts attributes object
  
  description string Required
  
  id string Required
  
  impact_areas array[string] Required
  
  Values are search, ingest, backup, or deployment_management.
  
  severity number Required
  
  diagnosis array[object]
  
  Hide diagnosis attributes Show diagnosis attributes object
  
  id string Required
  
  action string Required
  
  affected_resources object Required
  
  cause string Required
  
  help_url string Required
  
  details object
  
  Hide details attributes Show details attributes object
  
  current_master object Required
  
  Hide current_master attributes Show current_master attributes object
  
  name
  
  node_id
  
  recent_masters array[object] Required
  
  exception_fetching_history object
  
  Hide exception_fetching_history attributes Show exception_fetching_history attributes object
  
  message string Required
  
  stack_trace string Required
  
  cluster_formation array[object]
  
  shards_availability object
  
  SHARDS_AVAILABILITY
  
  Hide shards_availability attributes Show shards_availability attributes object
  
  status string Required
  
  Values are green, yellow, red, or unknown.
  
  symptom string Required
  
  impacts array[object]
  
  Hide impacts attributes Show impacts attributes object
  
  description string Required
  
  id string Required
  
  impact_areas array[string] Required
  
  Values are search, ingest, backup, or deployment_management.
  
  severity number Required
  
  diagnosis array[object]
  
  Hide diagnosis attributes Show diagnosis attributes object
  
  id string Required
  
  action string Required
  
  affected_resources object Required
  
  cause string Required
  
  help_url string Required
  
  details object
  
  Hide details attributes Show details attributes object
  
  creating_primaries number Required
  
  creating_replicas number Required
  
  initializing_primaries number Required
  
  initializing_replicas number Required
  
  restarting_primaries number Required
  
  restarting_replicas number Required
  
  started_primaries number Required
  
  started_replicas number Required
  
  unassigned_primaries number Required
  
  unassigned_replicas number Required
  
  disk object
  
  DISK
  
  Hide disk attributes Show disk attributes object
  
  status string Required
  
  Values are green, yellow, red, or unknown.
  
  symptom string Required
  
  impacts array[object]
  
  Hide impacts attributes Show impacts attributes object
  
  description string Required
  
  id string Required
  
  impact_areas array[string] Required
  
  Values are search, ingest, backup, or deployment_management.
  
  severity number Required
  
  diagnosis array[object]
  
  Hide diagnosis attributes Show diagnosis attributes object
  
  id string Required
  
  action string Required
  
  affected_resources object Required
  
  cause string Required
  
  help_url string Required
  
  details object
  
  Hide details attributes Show details attributes object
  
  indices_with_readonly_block number Required
  
  nodes_with_enough_disk_space number Required
  
  nodes_over_high_watermark number Required
  
  nodes_over_flood_stage_watermark number Required
  
  nodes_with_unknown_disk_status number Required
  
  repository_integrity object
  
  REPOSITORY_INTEGRITY
  
  Hide repository_integrity attributes Show repository_integrity attributes object
  
  status string Required
  
  Values are green, yellow, red, or unknown.
  
  symptom string Required
  
  impacts array[object]
  
  Hide impacts attributes Show impacts attributes object
  
  description string Required
  
  id string Required
  
  impact_areas array[string] Required
  
  Values are search, ingest, backup, or deployment_management.
  
  severity number Required
  
  diagnosis array[object]
  
  Hide diagnosis attributes Show diagnosis attributes object
  
  id string Required
  
  action string Required
  
  affected_resources object Required
  
  cause string Required
  
  help_url string Required
  
  details object
  
  Hide details attributes Show details attributes object
  
  total_repositories number
  
  corrupted_repositories number
  
  corrupted array[string]
  
  data_stream_lifecycle object
  
  DATA_STREAM_LIFECYCLE
  
  Hide data_stream_lifecycle attributes Show data_stream_lifecycle attributes object
  
  status string Required
  
  Values are green, yellow, red, or unknown.
  
  symptom string Required
  
  impacts array[object]
  
  Hide impacts attributes Show impacts attributes object
  
  description string Required
  
  id string Required
  
  impact_areas array[string] Required
  
  Values are search, ingest, backup, or deployment_management.
  
  severity number Required
  
  diagnosis array[object]
  
  Hide diagnosis attributes Show diagnosis attributes object
  
  id string Required
  
  action string Required
  
  affected_resources object Required
  
  cause string Required
  
  help_url string Required
  
  details object
  
  Hide details attributes Show details attributes object
  
  stagnating_backing_indices_count number Required
  
  total_backing_indices_in_error number Required
  
  stagnating_backing_indices array[object]
  
  ilm object
  
  ILM
  
  Hide ilm attributes Show ilm attributes object
  
  status string Required
  
  Values are green, yellow, red, or unknown.
  
  symptom string Required
  
  impacts array[object]
  
  Hide impacts attributes Show impacts attributes object
  
  description string Required
  
  id string Required
  
  impact_areas array[string] Required
  
  Values are search, ingest, backup, or deployment_management.
  
  severity number Required
  
  diagnosis array[object]
  
  Hide diagnosis attributes Show diagnosis attributes object
  
  id string Required
  
  action string Required
  
  affected_resources object Required
  
  cause string Required
  
  help_url string Required
  
  details object
  
  Hide details attributes Show details attributes object
  
  ilm_status string Required
  
  Values are RUNNING, STOPPING, or STOPPED.
  
  policies number Required
  
  stagnating_indices number Required
  
  slm object
  
  SLM
  
  Hide slm attributes Show slm attributes object
  
  status string Required
  
  Values are green, yellow, red, or unknown.
  
  symptom string Required
  
  impacts array[object]
  
  Hide impacts attributes Show impacts attributes object
  
  description string Required
  
  id string Required
  
  impact_areas array[string] Required
  
  Values are search, ingest, backup, or deployment_management.
  
  severity number Required
  
  diagnosis array[object]
  
  Hide diagnosis attributes Show diagnosis attributes object
  
  id string Required
  
  action string Required
  
  affected_resources object Required
  
  cause string Required
  
  help_url string Required
  
  details object
  
  Hide details attributes Show details attributes object
  
  slm_status string Required
  
  Values are RUNNING, STOPPING, or STOPPED.
  
  policies number Required
  
  unhealthy_policies object
  
  Hide unhealthy_policies attributes Show unhealthy_policies attributes object
  
  count number Required
  
  invocations_since_last_success object
  
  shards_capacity object
  
  SHARDS_CAPACITY
  
  Hide shards_capacity attributes Show shards_capacity attributes object
  
  status string Required
  
  Values are green, yellow, red, or unknown.
  
  symptom string Required
  
  impacts array[object]
  
  Hide impacts attributes Show impacts attributes object
  
  description string Required
  
  id string Required
  
  impact_areas array[string] Required
  
  Values are search, ingest, backup, or deployment_management.
  
  severity number Required
  
  diagnosis array[object]
  
  Hide diagnosis attributes Show diagnosis attributes object
  
  id string Required
  
  action string Required
  
  affected_resources object Required
  
  cause string Required
  
  help_url string Required
  
  details object
  
  Hide details attributes Show details attributes object
  
  data object Required
  
  Hide data attributes Show data attributes object
  
  max_shards_in_cluster number Required
  
  current_used_shards number
  
  frozen object Required
  
  Hide frozen attributes Show frozen attributes object
  
  max_shards_in_cluster number Required
  
  current_used_shards number
- status string
  
  Values are green, yellow, red, or unknown.

GET /_health_report

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

Connector

The connector and sync jobs APIs provide a convenient way to create and manage Elastic connectors and sync jobs in an internal index. Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure:

Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud
Self-managed connectors (Connector clients) are self-managed on your infrastructure.

This API provides an alternative to relying solely on Kibana UI for connector and sync job management. The API comes with a set of validations and assertions to ensure that the state representation in the internal index remains valid.

Check out the connector API tutorial

Check in a connector Technical preview; Added in 8.12.0

PUT /_connector/{connector_id}/_check_in

Api key auth Basic auth Bearer auth

Update the last_seen field in the connector and set it to the current timestamp.

Path parameters

connector_id string Required

The unique identifier of the connector to be checked in

Responses

200 application/json
Hide response attribute Show response attribute object
- result string Required
  
  Values are created, updated, deleted, not_found, or noop.

PUT /_connector/{connector_id}/_check_in

curl \
 --request PUT 'http://api.example.com/_connector/{connector_id}/_check_in' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
    "result": "updated"
}

Set a connector sync job error Technical preview

PUT /_connector/_sync_job/{connector_sync_job_id}/_error

Api key auth Basic auth Bearer auth

Set the error field for a connector sync job and set its status to error.

To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

Path parameters

connector_sync_job_id string Required

The unique identifier for the connector sync job.

application/json

Body Required

error string Required

The error for the connector sync job error field.

Responses

200 application/json

PUT /_connector/_sync_job/{connector_sync_job_id}/_error

curl \
 --request PUT 'http://api.example.com/_connector/_sync_job/{connector_sync_job_id}/_error' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n    \"error\": \"some-error\"\n}"'

Request example

{
    "error": "some-error"
}

Activate the connector draft filter Technical preview; Added in 8.12.0

PUT /_connector/{connector_id}/_filtering/_activate

Api key auth Basic auth Bearer auth

Activates the valid draft filtering for a connector.

Path parameters

connector_id string Required

The unique identifier of the connector to be updated

Responses

200 application/json
Hide response attribute Show response attribute object
- result string Required
  
  Values are created, updated, deleted, not_found, or noop.

PUT /_connector/{connector_id}/_filtering/_activate

curl \
 --request PUT 'http://api.example.com/_connector/{connector_id}/_filtering/_activate' \
 --header "Authorization: $API_KEY"

Update the connector API key ID Beta; Added in 8.12.0

PUT /_connector/{connector_id}/_api_key_id

Api key auth Basic auth Bearer auth

Update the api_key_id and api_key_secret_id fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field.

Path parameters

connector_id string Required

The unique identifier of the connector to be updated

application/json

Body Required

api_key_id string
api_key_secret_id string

Responses

200 application/json
Hide response attribute Show response attribute object
- result string Required
  
  Values are created, updated, deleted, not_found, or noop.

PUT /_connector/{connector_id}/_api_key_id

curl \
 --request PUT 'http://api.example.com/_connector/{connector_id}/_api_key_id' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n    \"api_key_id\": \"my-api-key-id\",\n    \"api_key_secret_id\": \"my-connector-secret-id\"\n}"'

Request example

{
    "api_key_id": "my-api-key-id",
    "api_key_secret_id": "my-connector-secret-id"
}

Response examples (200)

{
  "result": "updated"
}

Update the connector error field Technical preview; Added in 8.12.0

PUT /_connector/{connector_id}/_error

Api key auth Basic auth Bearer auth

Set the error field for the connector. If the error provided in the request body is non-null, the connector’s status is updated to error. Otherwise, if the error is reset to null, the connector status is updated to connected.

Path parameters

connector_id string Required

The unique identifier of the connector to be updated

application/json

Body Required

error string | null Required

One of:
string-1 string NullValue string | null

Responses

200 application/json
Hide response attribute Show response attribute object
- result string Required
  
  Values are created, updated, deleted, not_found, or noop.

PUT /_connector/{connector_id}/_error

curl \
 --request PUT 'http://api.example.com/_connector/{connector_id}/_error' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n    \"error\": \"Houston, we have a problem!\"\n}"'

Request example

{
    "error": "Houston, we have a problem!"
}

Response examples (200)

{
  "result": "updated"
}

Update the connector features Technical preview

PUT /_connector/{connector_id}/_features

Api key auth Basic auth Bearer auth

Update the connector features in the connector document. This API can be used to control the following aspects of a connector:

document-level security
incremental syncs
advanced sync rules
basic sync rules

Normally, the running connector service automatically manages these features. However, you can use this API to override the default behavior.

To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

Path parameters

connector_id string Required

The unique identifier of the connector to be updated.

application/json

Body Required

features object Required
Hide features attributes Show features attributes object
- document_level_security object
  Hide document_level_security attribute Show document_level_security attribute object
  
  enabled boolean Required
- incremental_sync object
  Hide incremental_sync attribute Show incremental_sync attribute object
  
  enabled boolean Required
- native_connector_api_keys object
  Hide native_connector_api_keys attribute Show native_connector_api_keys attribute object
  
  enabled boolean Required
- sync_rules object
  Hide sync_rules attributes Show sync_rules attributes object
  
  advanced object
  
  Hide advanced attribute Show advanced attribute object
  
  enabled boolean Required
  
  basic object
  
  Hide basic attribute Show basic attribute object
  
  enabled boolean Required

Responses

200 application/json
Hide response attribute Show response attribute object
- result string Required
  
  Values are created, updated, deleted, not_found, or noop.

PUT /_connector/{connector_id}/_features

curl \
 --request PUT 'http://api.example.com/_connector/{connector_id}/_features' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"features\": {\n    \"document_level_security\": {\n      \"enabled\": true\n    },\n    \"incremental_sync\": {\n      \"enabled\": true\n    },\n    \"sync_rules\": {\n      \"advanced\": {\n        \"enabled\": false\n      },\n      \"basic\": {\n        \"enabled\": true\n      }\n    }\n  }\n}"'

Request examples

{
  "features": {
    "document_level_security": {
      "enabled": true
    },
    "incremental_sync": {
      "enabled": true
    },
    "sync_rules": {
      "advanced": {
        "enabled": false
      },
      "basic": {
        "enabled": true
      }
    }
  }
}

{
  "features": {
    "document_level_security": {
      "enabled": true
    }
  }
}

Response examples (200)

{
  "result": "updated"
}

Update the connector filtering Beta; Added in 8.12.0

PUT /_connector/{connector_id}/_filtering

Api key auth Basic auth Bearer auth

Update the draft filtering configuration of a connector and marks the draft validation state as edited. The filtering draft is activated once validated by the running Elastic connector service. The filtering property is used to configure sync rules (both basic and advanced) for a connector.

Path parameters

connector_id string Required

The unique identifier of the connector to be updated

application/json

Body Required

filtering array[object]
Hide filtering attributes Show filtering attributes object
- active object Required
  Hide active attributes Show active attributes object
  
  advanced_snippet object Required
  
  Hide advanced_snippet attributes Show advanced_snippet attributes object
  
  created_at string | number
  
  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
  
  updated_at string | number
  
  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
  
  value object Required
  
  rules array[object] Required
  
  Hide rules attributes Show rules attributes object
  
  created_at string
  
  field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  id string Required
  
  order number Required
  
  policy string Required
  
  Values are exclude or include.
  
  rule string Required
  
  Values are contains, ends_with, equals, regex, starts_with, >, or <.
  
  updated_at string
  
  value string Required
  
  validation object Required
  
  Hide validation attributes Show validation attributes object
  
  errors array[object] Required
  
  Hide errors attributes Show errors attributes object
  
  ids array[string] Required
  
  messages array[string] Required
  
  state string Required
  
  Values are edited, invalid, or valid.
- domain string
- draft object Required
  Hide draft attributes Show draft attributes object
  
  advanced_snippet object Required
  
  Hide advanced_snippet attributes Show advanced_snippet attributes object
  
  created_at string | number
  
  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
  
  updated_at string | number
  
  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
  
  value object Required
  
  rules array[object] Required
  
  Hide rules attributes Show rules attributes object
  
  created_at string
  
  field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  id string Required
  
  order number Required
  
  policy string Required
  
  Values are exclude or include.
  
  rule string Required
  
  Values are contains, ends_with, equals, regex, starts_with, >, or <.
  
  updated_at string
  
  value string Required
  
  validation object Required
  
  Hide validation attributes Show validation attributes object
  
  errors array[object] Required
  
  Hide errors attributes Show errors attributes object
  
  ids array[string] Required
  
  messages array[string] Required
  
  state string Required
  
  Values are edited, invalid, or valid.
rules array[object]
Hide rules attributes Show rules attributes object
- created_at string | number
  
  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
- field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
- id string Required
- order number Required
- policy string Required
  
  Values are exclude or include.
- rule string Required
  
  Values are contains, ends_with, equals, regex, starts_with, >, or <.
- updated_at string | number
  
  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
- value string Required
advanced_snippet object
Hide advanced_snippet attributes Show advanced_snippet attributes object
- created_at string | number
  
  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
- updated_at string | number
  
  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
- value object Required

Responses

200 application/json
Hide response attribute Show response attribute object
- result string Required
  
  Values are created, updated, deleted, not_found, or noop.

PUT /_connector/{connector_id}/_filtering

curl \
 --request PUT 'http://api.example.com/_connector/{connector_id}/_filtering' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n    \"rules\": [\n         {\n            \"field\": \"file_extension\",\n            \"id\": \"exclude-txt-files\",\n            \"order\": 0,\n            \"policy\": \"exclude\",\n            \"rule\": \"equals\",\n            \"value\": \"txt\"\n        },\n        {\n            \"field\": \"_\",\n            \"id\": \"DEFAULT\",\n            \"order\": 1,\n            \"policy\": \"include\",\n            \"rule\": \"regex\",\n            \"value\": \".*\"\n        }\n    ]\n}"'

Request examples

{
    "rules": [
         {
            "field": "file_extension",
            "id": "exclude-txt-files",
            "order": 0,
            "policy": "exclude",
            "rule": "equals",
            "value": "txt"
        },
        {
            "field": "_",
            "id": "DEFAULT",
            "order": 1,
            "policy": "include",
            "rule": "regex",
            "value": ".*"
        }
    ]
}

{
    "advanced_snippet": {
        "value": [{
            "tables": [
                "users",
                "orders"
            ],
            "query": "SELECT users.id AS id, orders.order_id AS order_id FROM users JOIN orders ON users.id = orders.user_id"
        }]
    }
}

Response examples (200)

{
  "result": "updated"
}

Update the connector name and description Beta; Added in 8.12.0

PUT /_connector/{connector_id}/_name

Api key auth Basic auth Bearer auth

Path parameters

connector_id string Required

The unique identifier of the connector to be updated

application/json

Body Required

name string
description string

Responses

200 application/json
Hide response attribute Show response attribute object
- result string Required
  
  Values are created, updated, deleted, not_found, or noop.

PUT /_connector/{connector_id}/_name

curl \
 --request PUT 'http://api.example.com/_connector/{connector_id}/_name' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n    \"name\": \"Custom connector\",\n    \"description\": \"This is my customized connector\"\n}"'

Request example

{
    "name": "Custom connector",
    "description": "This is my customized connector"
}

Response examples (200)

{
  "result": "updated"
}

Update the connector scheduling Beta; Added in 8.12.0

PUT /_connector/{connector_id}/_scheduling

Api key auth Basic auth Bearer auth

Path parameters

connector_id string Required

The unique identifier of the connector to be updated

application/json

Body Required

scheduling object Required
Hide scheduling attributes Show scheduling attributes object
- access_control object
  Hide access_control attributes Show access_control attributes object
  
  enabled boolean Required
  
  interval string Required
  
  The interval is expressed using the crontab syntax
- full object
  Hide full attributes Show full attributes object
  
  enabled boolean Required
  
  interval string Required
  
  The interval is expressed using the crontab syntax
- incremental object
  Hide incremental attributes Show incremental attributes object
  
  enabled boolean Required
  
  interval string Required
  
  The interval is expressed using the crontab syntax

Responses

200 application/json
Hide response attribute Show response attribute object
- result string Required
  
  Values are created, updated, deleted, not_found, or noop.

PUT /_connector/{connector_id}/_scheduling

curl \
 --request PUT 'http://api.example.com/_connector/{connector_id}/_scheduling' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n    \"scheduling\": {\n        \"access_control\": {\n            \"enabled\": true,\n            \"interval\": \"0 10 0 * * ?\"\n        },\n        \"full\": {\n            \"enabled\": true,\n            \"interval\": \"0 20 0 * * ?\"\n        },\n        \"incremental\": {\n            \"enabled\": false,\n            \"interval\": \"0 30 0 * * ?\"\n        }\n    }\n}"'

Request examples

{
    "scheduling": {
        "access_control": {
            "enabled": true,
            "interval": "0 10 0 * * ?"
        },
        "full": {
            "enabled": true,
            "interval": "0 20 0 * * ?"
        },
        "incremental": {
            "enabled": false,
            "interval": "0 30 0 * * ?"
        }
    }
}

{
    "scheduling": {
        "full": {
            "enabled": true,
            "interval": "0 10 0 * * ?"
        }
    }
}

Response examples (200)

{
  "result": "updated"
}

Update the connector service type Beta; Added in 8.12.0

PUT /_connector/{connector_id}/_service_type

Api key auth Basic auth Bearer auth

Path parameters

connector_id string Required

The unique identifier of the connector to be updated

application/json

Body Required

service_type string Required

Responses

200 application/json
Hide response attribute Show response attribute object
- result string Required
  
  Values are created, updated, deleted, not_found, or noop.

PUT /_connector/{connector_id}/_service_type

curl \
 --request PUT 'http://api.example.com/_connector/{connector_id}/_service_type' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n    \"service_type\": \"sharepoint_online\"\n}"'

Request example

{
    "service_type": "sharepoint_online"
}

Response examples (200)

{
  "result": "updated"
}

Update the connector status Technical preview; Added in 8.12.0

PUT /_connector/{connector_id}/_status

Api key auth Basic auth Bearer auth

Path parameters

connector_id string Required

The unique identifier of the connector to be updated

application/json

Body Required

status string Required

Values are created, needs_configuration, configured, connected, or error.

Responses

200 application/json
Hide response attribute Show response attribute object
- result string Required
  
  Values are created, updated, deleted, not_found, or noop.

PUT /_connector/{connector_id}/_status

curl \
 --request PUT 'http://api.example.com/_connector/{connector_id}/_status' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n    \"status\": \"needs_configuration\"\n}"'

Request example

{
    "status": "needs_configuration"
}

Response examples (200)

{
  "result": "updated"
}

Delete auto-follow patterns Generally available; Added in 6.5.0

DELETE /_ccr/auto_follow/{name}

Api key auth Basic auth Bearer auth

Delete a collection of cross-cluster replication auto-follow patterns.

Required authorization

Cluster privileges: manage_ccr

External documentation

Path parameters

name string Required

The auto-follow pattern collection to delete.

Query parameters

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. It can also be set to -1 to indicate that the request should never timeout.

Values are -1 or 0.

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.

DELETE /_ccr/auto_follow/{name}

curl \
 --request DELETE 'http://api.example.com/_ccr/auto_follow/{name}' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `DELETE /_ccr/auto_follow/my_auto_follow_pattern`, which deletes an auto-follow pattern.

{
  "acknowledged" : true
}

Get follower information Generally available; Added in 6.7.0

GET /{index}/_ccr/info

Api key auth Basic auth Bearer auth

Get information about all cross-cluster replication follower indices. For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.

Required authorization

Cluster privileges: monitor

External documentation

Path parameters

index string | array[string] Required

A comma-delimited list of follower index patterns.

Query parameters

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. It can also be set to -1 to indicate that the request should never timeout.

Values are -1 or 0.

Responses

200 application/json
Hide response attribute Show response attribute object
- follower_indices array[object] Required
  
  Hide follower_indices attributes Show follower_indices attributes object
  
  follower_index string Required
  
  leader_index string Required
  
  parameters object
  
  Hide parameters attributes Show parameters attributes object
  
  max_outstanding_read_requests number
  
  The maximum number of outstanding reads requests from the remote cluster.
  
  max_outstanding_write_requests number
  
  The maximum number of outstanding write requests on the follower.
  
  max_read_request_operation_count number
  
  The maximum number of operations to pull per read from the remote cluster.
  
  max_read_request_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  max_retry_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.
  
  max_write_buffer_count number
  
  The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.
  
  max_write_buffer_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  max_write_request_operation_count number
  
  The maximum number of operations per bulk write request executed on the follower.
  
  max_write_request_size number | string
  
  One of:
  ByteSize number ByteSize string
  
  read_poll_timeout 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.
  
  remote_cluster string Required
  
  status string Required
  
  Values are active or paused.

GET /{index}/_ccr/info

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

Response examples (200)

A successful response from `GET /follower_index/_ccr/info` when the follower index is active.

{
  "follower_indices": [
    {
      "follower_index": "follower_index",
      "remote_cluster": "remote_cluster",
      "leader_index": "leader_index",
      "status": "active",
      "parameters": {
        "max_read_request_operation_count": 5120,
        "max_read_request_size": "32mb",
        "max_outstanding_read_requests": 12,
        "max_write_request_operation_count": 5120,
        "max_write_request_size": "9223372036854775807b",
        "max_outstanding_write_requests": 9,
        "max_write_buffer_count": 2147483647,
        "max_write_buffer_size": "512mb",
        "max_retry_delay": "500ms",
        "read_poll_timeout": "1m"
      }
    }
  ]
}

A successful response from `GET /follower_index/_ccr/info` when the follower index is paused.

{
  "follower_indices": [
    {
      "follower_index": "follower_index",
      "remote_cluster": "remote_cluster",
      "leader_index": "leader_index",
      "status": "paused"
    }
  ]
}

Forget a follower Generally available; Added in 6.7.0

POST /{index}/_ccr/forget_follower

Api key auth Basic auth Bearer auth

Remove the cross-cluster replication follower retention leases from the leader.

A following index takes out retention leases on its leader index. These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. This API exists to enable manually removing the leases when the unfollow API is unable to do so.

NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.

External documentation

Path parameters

index string Required

the name of the leader index for which specified follower retention leases should be removed

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.

Values are -1 or 0.

application/json

Body Required

follower_cluster string
follower_index string
follower_index_uuid string
leader_remote_cluster string

Responses

200 application/json
Hide response attribute Show response attribute object
- _shards object Required
  
  Hide _shards attributes Show _shards attributes object
  
  failed number Required
  
  successful number Required
  
  total number Required
  
  failures array[object]
  
  Hide failures attributes Show failures attributes object
  
  index string
  
  node string
  
  reason object Required
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide reason attributes Show reason attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  shard number Required
  
  status string
  
  skipped number

POST /{index}/_ccr/forget_follower

curl \
 --request POST 'http://api.example.com/{index}/_ccr/forget_follower' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"follower_cluster\" : \"\u003cfollower_cluster\u003e\",\n  \"follower_index\" : \"\u003cfollower_index\u003e\",\n  \"follower_index_uuid\" : \"\u003cfollower_index_uuid\u003e\",\n  \"leader_remote_cluster\" : \"\u003cleader_remote_cluster\u003e\"\n}"'

Request example

Run `POST /<leader_index>/_ccr/forget_follower`.

{
  "follower_cluster" : "<follower_cluster>",
  "follower_index" : "<follower_index>",
  "follower_index_uuid" : "<follower_index_uuid>",
  "leader_remote_cluster" : "<leader_remote_cluster>"
}

Response examples (200)

A successful response for removing the follower retention leases from the leader index.

{
  "_shards" : {
    "total" : 1,
    "successful" : 1,
    "failed" : 0,
    "failures" : [ ]
  }
}

Get auto-follow patterns Generally available; Added in 6.5.0

GET /_ccr/auto_follow

Api key auth Basic auth Bearer auth

Get cross-cluster replication auto-follow patterns.

Required authorization

Cluster privileges: manage_ccr

External documentation

Query parameters

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. It can also be set to -1 to indicate that the request should never timeout.

Values are -1 or 0.

Responses

200 application/json
Hide response attribute Show response attribute object
- patterns array[object] Required
  
  Hide patterns attributes Show patterns attributes object
  
  name string Required
  
  pattern object Required
  
  Hide pattern attributes Show pattern attributes object
  
  active boolean Required
  
  remote_cluster string Required
  
  The remote cluster containing the leader indices to match against.
  
  follow_index_pattern string
  
  leader_index_patterns array[string] Required
  
  leader_index_exclusion_patterns array[string] Required
  
  max_outstanding_read_requests number Required
  
  The maximum number of outstanding reads requests from the remote cluster.

GET /_ccr/auto_follow

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

Response examples (200)

A successful response from `GET /_ccr/auto_follow/my_auto_follow_pattern`, which gets auto-follow patterns.

{
  "patterns": [
    {
      "name": "my_auto_follow_pattern",
      "pattern": {
        "active": true,
        "remote_cluster" : "remote_cluster",
        "leader_index_patterns" :
        [
          "leader_index*"
        ],
        "leader_index_exclusion_patterns":
        [
          "leader_index_001"
        ],
        "follow_index_pattern" : "{{leader_index}}-follower"
      }
    }
  ]
}

Pause an auto-follow pattern Generally available; Added in 7.5.0

POST /_ccr/auto_follow/{name}/pause

Api key auth Basic auth Bearer auth

Pause a cross-cluster replication auto-follow pattern. When the API returns, the auto-follow pattern is inactive. New indices that are created on the remote cluster and match the auto-follow patterns are ignored.

You can resume auto-following with the resume auto-follow pattern API. When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.

Required authorization

Cluster privileges: manage_ccr

External documentation

Path parameters

name string Required

The name of the auto-follow pattern to pause.

Query parameters

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. It can also be set to -1 to indicate that the request should never timeout.

Values are -1 or 0.

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.

POST /_ccr/auto_follow/{name}/pause

curl \
 --request POST 'http://api.example.com/_ccr/auto_follow/{name}/pause' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `POST /_ccr/auto_follow/my_auto_follow_pattern/pause`, which pauses an auto-follow pattern.

{
  "acknowledged" : true
}

Resume a follower Generally available; Added in 6.5.0

POST /{index}/_ccr/resume_follow

Api key auth Basic auth Bearer auth

Resume a cross-cluster replication follower index that was paused. The follower index could have been paused with the pause follower API. Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. When this API returns, the follower index will resume fetching operations from the leader index.

External documentation

Path parameters

index string Required

The name of the follow index to resume following.

Query parameters

master_timeout string

Period to wait for a connection to the master node.

Values are -1 or 0.

application/json

Body

max_outstanding_read_requests number
max_outstanding_write_requests number
max_read_request_operation_count number
max_read_request_size string
max_retry_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.
max_write_buffer_count number
max_write_buffer_size string
max_write_request_operation_count number
max_write_request_size string
read_poll_timeout 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.

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.

POST /{index}/_ccr/resume_follow

curl \
 --request POST 'http://api.example.com/{index}/_ccr/resume_follow' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"max_read_request_operation_count\" : 1024,\n  \"max_outstanding_read_requests\" : 16,\n  \"max_read_request_size\" : \"1024k\",\n  \"max_write_request_operation_count\" : 32768,\n  \"max_write_request_size\" : \"16k\",\n  \"max_outstanding_write_requests\" : 8,\n  \"max_write_buffer_count\" : 512,\n  \"max_write_buffer_size\" : \"512k\",\n  \"max_retry_delay\" : \"10s\",\n  \"read_poll_timeout\" : \"30s\"\n}"'

Request example

Run `POST /follower_index/_ccr/resume_follow` to resume the follower index.

{
  "max_read_request_operation_count" : 1024,
  "max_outstanding_read_requests" : 16,
  "max_read_request_size" : "1024k",
  "max_write_request_operation_count" : 32768,
  "max_write_request_size" : "16k",
  "max_outstanding_write_requests" : 8,
  "max_write_buffer_count" : 512,
  "max_write_buffer_size" : "512k",
  "max_retry_delay" : "10s",
  "read_poll_timeout" : "30s"
}

Response examples (200)

A successful response from resuming a folower index.

{
  "acknowledged" : true
}

Get cross-cluster replication stats Generally available; Added in 6.5.0

GET /_ccr/stats

Api key auth Basic auth Bearer auth

This API returns stats about auto-following and the same shard-level stats as the get follower stats API.

Required authorization

Cluster privileges: monitor

Query parameters

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. It can also be set to -1 to indicate that the request should never timeout.

Values are -1 or 0.
timeout string

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

Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- auto_follow_stats object Required
  
  Hide auto_follow_stats attributes Show auto_follow_stats attributes object
  
  auto_followed_clusters array[object] Required
  
  Hide auto_followed_clusters attributes Show auto_followed_clusters attributes object
  
  cluster_name string Required
  
  last_seen_metadata_version number Required
  
  time_since_last_check_millis number
  
  Time unit for milliseconds
  
  number_of_failed_follow_indices number Required
  
  The number of indices that the auto-follow coordinator failed to automatically follow. The causes of recent failures are captured in the logs of the elected master node and in the auto_follow_stats.recent_auto_follow_errors field.
  
  number_of_failed_remote_cluster_state_requests number Required
  
  The number of times that the auto-follow coordinator failed to retrieve the cluster state from a remote cluster registered in a collection of auto-follow patterns.
  
  number_of_successful_follow_indices number Required
  
  The number of indices that the auto-follow coordinator successfully followed.
  
  recent_auto_follow_errors array[object] Required
  
  An array of objects representing failures by the auto-follow coordinator.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide recent_auto_follow_errors attributes Show recent_auto_follow_errors attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
- follow_stats object Required
  
  Hide follow_stats attribute Show follow_stats attribute object
  
  indices array[object] Required
  
  Hide indices attributes Show indices attributes object
  
  index string Required
  
  shards array[object] Required
  
  An array of shard-level following task statistics.
  
  Hide shards attributes Show shards attributes object
  
  bytes_read number Required
  
  The total of transferred bytes read from the leader. This is only an estimate and does not account for compression if enabled.
  
  failed_read_requests number Required
  
  The number of failed reads.
  
  failed_write_requests number Required
  
  The number of failed bulk write requests on the follower.
  
  fatal_exception object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  follower_aliases_version number Required
  
  follower_global_checkpoint number Required
  
  The current global checkpoint on the follower. The difference between the leader_global_checkpoint and the follower_global_checkpoint is an indication of how much the follower is lagging the leader.
  
  follower_index string Required
  
  The name of the follower index.
  
  follower_mapping_version number Required
  
  follower_max_seq_no number Required
  
  follower_settings_version number Required
  
  last_requested_seq_no number Required
  
  leader_global_checkpoint number Required
  
  The current global checkpoint on the leader known to the follower task.
  
  leader_index string Required
  
  The name of the index in the leader cluster being followed.
  
  leader_max_seq_no number Required
  
  operations_read number Required
  
  The total number of operations read from the leader.
  
  operations_written number Required
  
  The number of operations written on the follower.
  
  outstanding_read_requests number Required
  
  The number of active read requests from the follower.
  
  outstanding_write_requests number Required
  
  The number of active bulk write requests on the follower.
  
  read_exceptions array[object] Required
  
  An array of objects representing failed reads.
  
  remote_cluster string Required
  
  The remote cluster containing the leader index.
  
  shard_id number Required
  
  The numerical shard ID, with values from 0 to one less than the number of replicas.
  
  successful_read_requests number Required
  
  The number of successful fetches.
  
  successful_write_requests number Required
  
  The number of bulk write requests run on the follower.
  
  time_since_last_read 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_since_last_read_millis
  
  total_read_remote_exec_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_read_remote_exec_time_millis
  
  total_read_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_read_time_millis
  
  total_write_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_write_time_millis
  
  write_buffer_operation_count number Required
  
  The number of write operations queued on the follower.
  
  write_buffer_size_in_bytes

GET /_ccr/stats

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

Response examples (200)

A successful response from `GET /_ccr/stats` that returns cross-cluster replication stats.

{
  "auto_follow_stats" : {
    "number_of_failed_follow_indices" : 0,
    "number_of_failed_remote_cluster_state_requests" : 0,
    "number_of_successful_follow_indices" : 1,
    "recent_auto_follow_errors" : [],
    "auto_followed_clusters" : []
  },
  "follow_stats" : {
    "indices" : [
      {
        "index" : "follower_index",
        "total_global_checkpoint_lag" : 256,
        "shards" : [
          {
            "remote_cluster" : "remote_cluster",
            "leader_index" : "leader_index",
            "follower_index" : "follower_index",
            "shard_id" : 0,
            "leader_global_checkpoint" : 1024,
            "leader_max_seq_no" : 1536,
            "follower_global_checkpoint" : 768,
            "follower_max_seq_no" : 896,
            "last_requested_seq_no" : 897,
            "outstanding_read_requests" : 8,
            "outstanding_write_requests" : 2,
            "write_buffer_operation_count" : 64,
            "follower_mapping_version" : 4,
            "follower_settings_version" : 2,
            "follower_aliases_version" : 8,
            "total_read_time_millis" : 32768,
            "total_read_remote_exec_time_millis" : 16384,
            "successful_read_requests" : 32,
            "failed_read_requests" : 0,
            "operations_read" : 896,
            "bytes_read" : 32768,
            "total_write_time_millis" : 16384,
            "write_buffer_size_in_bytes" : 1536,
            "successful_write_requests" : 16,
            "failed_write_requests" : 0,
            "operations_written" : 832,
            "read_exceptions" : [ ],
            "time_since_last_read_millis" : 8
          }
        ]
      }
    ]
  }
}

Unfollow an index Generally available; Added in 6.5.0

POST /{index}/_ccr/unfollow

Api key auth Basic auth Bearer auth

Convert a cross-cluster replication follower index to a regular index. The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. The follower index must be paused and closed before you call the unfollow API.

Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.

Required authorization

Index privileges: manage_follow_index

External documentation

Path parameters

index string Required

The name of the follower index.

Query parameters

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. It can also be set to -1 to indicate that the request should never timeout.

Values are -1 or 0.

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.

POST /{index}/_ccr/unfollow

curl \
 --request POST 'http://api.example.com/{index}/_ccr/unfollow' \
 --header "Authorization: $API_KEY"

Response examples (200)

A successful response from `POST /follower_index/_ccr/unfollow`.

{
  "acknowledged" : true
}

Get data streams Generally available; Added in 7.9.0

GET /_data_stream/{name}

Api key auth Basic auth Bearer auth

Get information about one or more data streams.

Required authorization

Index privileges: view_index_metadata

Path parameters

name string | array[string] Required

Comma-separated list of data stream names used to limit the request. Wildcard (*) expressions are supported. If omitted, all data streams are returned.

Query parameters

expand_wildcards string | array[string]

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

Values are all, open, closed, hidden, or none.
include_defaults boolean

If true, returns all relevant default configurations for the index template.
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.

Values are -1 or 0.
verbose boolean

Whether the maximum timestamp for each data stream should be calculated and returned.

Responses

200 application/json
Hide response attribute Show response attribute object
- data_streams array[object] Required
  
  Hide data_streams attributes Show data_streams attributes object
  
  _meta object
  
  Hide _meta attribute Show _meta attribute object
  
  * object Additional properties
  
  allow_custom_routing boolean
  
  If true, the data stream allows custom routing on write request.
  
  failure_store object
  
  Hide failure_store attributes Show failure_store attributes object
  
  enabled boolean Required
  
  indices array[object] Required
  
  Hide indices attributes Show indices attributes object
  
  index_name string Required
  
  index_uuid string Required
  
  ilm_policy string
  
  managed_by string
  
  Values are Index Lifecycle Management, Data stream lifecycle, or Unmanaged.
  
  prefer_ilm boolean
  
  Indicates if ILM should take precedence over DSL in case both are configured to manage this index.
  
  rollover_on_write boolean Required
  
  generation number Required
  
  Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1.
  
  hidden boolean Required
  
  If true, the data stream is hidden.
  
  ilm_policy string
  
  next_generation_managed_by string Required
  
  Values are Index Lifecycle Management, Data stream lifecycle, or Unmanaged.
  
  prefer_ilm boolean Required
  
  Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.
  
  indices array[object] Required
  
  Array of objects containing information about the data stream’s backing indices. The last item in this array contains information about the stream’s current write index.
  
  Hide indices attributes Show indices attributes object
  
  index_name string Required
  
  index_uuid string Required
  
  ilm_policy string
  
  managed_by string
  
  Values are Index Lifecycle Management, Data stream lifecycle, or Unmanaged.
  
  prefer_ilm boolean
  
  Indicates if ILM should take precedence over DSL in case both are configured to manage this index.
  
  lifecycle object
  
  Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions, if asked.
  
  Hide lifecycle attributes Show lifecycle attributes object
  
  data_retention 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.
  
  downsampling object
  
  Hide downsampling attribute Show downsampling attribute object
  
  rounds array[object] Required
  
  The list of downsampling rounds to execute as part of this downsampling configuration
  
  enabled boolean
  
  If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that's disabled (enabled: false) will have no effect on the data stream.
  
  rollover object
  
  Hide rollover attributes Show rollover attributes object
  
  min_age 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_age string
  
  min_docs number
  
  max_docs number
  
  min_size
  
  max_size
  
  min_primary_shard_size
  
  max_primary_shard_size
  
  min_primary_shard_docs number
  
  max_primary_shard_docs number
  
  name string Required
  
  replicated boolean
  
  If true, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings.
  
  rollover_on_write boolean Required
  
  If true, the next write to this data stream will trigger a rollover first and the document will be indexed in the new backing index. If the rollover fails the indexing request will fail too.
  
  status string Required
  
  Values are green, GREEN, yellow, YELLOW, red, or RED.
  
  system boolean Generally available; Added in 7.10.0
  
  If true, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction.
  
  template string Required
  
  timestamp_field object Required
  
  Hide timestamp_field attribute Show timestamp_field attribute object
  
  name string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

GET /_data_stream/{name}

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

Response examples (200)

A successful response for retrieving information about a data stream.

{
  "data_streams": [
    {
      "name": "my-data-stream",
      "timestamp_field": {
        "name": "@timestamp"
      },
      "indices": [
        {
          "index_name": ".ds-my-data-stream-2099.03.07-000001",
          "index_uuid": "xCEhwsp8Tey0-FLNFYVwSg",
          "prefer_ilm": true,
          "ilm_policy": "my-lifecycle-policy",
          "managed_by": "Index Lifecycle Management"
        },
        {
          "index_name": ".ds-my-data-stream-2099.03.08-000002",
          "index_uuid": "PA_JquKGSiKcAKBA8DJ5gw",
          "prefer_ilm": true,
          "ilm_policy": "my-lifecycle-policy",
          "managed_by": "Index Lifecycle Management"
        }
      ],
      "generation": 2,
      "_meta": {
        "my-meta-field": "foo"
      },
      "status": "GREEN",
      "next_generation_managed_by": "Index Lifecycle Management",
      "prefer_ilm": true,
      "template": "my-index-template",
      "ilm_policy": "my-lifecycle-policy",
      "hidden": false,
      "system": false,
      "allow_custom_routing": false,
      "replicated": false,
      "rollover_on_write": false
    },
    {
      "name": "my-data-stream-two",
      "timestamp_field": {
        "name": "@timestamp"
      },
      "indices": [
        {
          "index_name": ".ds-my-data-stream-two-2099.03.08-000001",
          "index_uuid": "3liBu2SYS5axasRt6fUIpA",
          "prefer_ilm": true,
          "ilm_policy": "my-lifecycle-policy",
          "managed_by": "Index Lifecycle Management"
        }
      ],
      "generation": 1,
      "_meta": {
        "my-meta-field": "foo"
      },
      "status": "YELLOW",
      "next_generation_managed_by": "Index Lifecycle Management",
      "prefer_ilm": true,
      "template": "my-index-template",
      "ilm_policy": "my-lifecycle-policy",
      "hidden": false,
      "system": false,
      "allow_custom_routing": false,
      "replicated": false,
      "rollover_on_write": false
    }
  ]
}

Get data stream lifecycles Generally available; Added in 8.11.0

GET /_data_stream/{name}/_lifecycle

Api key auth Basic auth Bearer auth

Get the data stream lifecycle configuration of one or more data streams.

External documentation

Path parameters

name string | array[string] Required

Comma-separated list of data streams to limit the request. Supports wildcards (*). To target all data streams, omit this parameter or use * or _all.

Query parameters

expand_wildcards string | array[string]

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

Values are all, open, closed, hidden, or none.
include_defaults boolean

If true, return all default settings in the response.
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.

Values are -1 or 0.

Responses

200 application/json
Hide response attribute Show response attribute object
- data_streams array[object] Required
  
  Hide data_streams attributes Show data_streams attributes object
  
  name string Required
  
  lifecycle object
  
  Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions, if asked.
  
  Hide lifecycle attributes Show lifecycle attributes object
  
  data_retention 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.
  
  downsampling object
  
  Hide downsampling attribute Show downsampling attribute object
  
  rounds array[object] Required
  
  The list of downsampling rounds to execute as part of this downsampling configuration
  
  enabled boolean
  
  If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that's disabled (enabled: false) will have no effect on the data stream.
  
  rollover object
  
  Hide rollover attributes Show rollover attributes object
  
  min_age 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_age string
  
  min_docs number
  
  max_docs number
  
  min_size
  
  max_size
  
  min_primary_shard_size
  
  max_primary_shard_size
  
  min_primary_shard_docs number
  
  max_primary_shard_docs number

GET /_data_stream/{name}/_lifecycle

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

Response examples (200)

A successful response from `GET /_data_stream/{name}/_lifecycle?human&pretty`.

{
  "data_streams": [
    {
      "name": "my-data-stream-1",
      "lifecycle": {
        "enabled": true,
        "data_retention": "7d"
      }
    },
    {
      "name": "my-data-stream-2",
      "lifecycle": {
        "enabled": true,
        "data_retention": "7d"
      }
    }
  ]
}

Update data stream lifecycles Generally available; Added in 8.11.0

PUT /_data_stream/{name}/_lifecycle

Api key auth Basic auth Bearer auth

Update the data stream lifecycle of the specified data streams.

External documentation

Path parameters

name string | array[string] Required

Comma-separated list of data streams used to limit the request. Supports wildcards (*). To target all data streams use * or _all.

Query parameters

expand_wildcards string | array[string]

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

Values are all, open, closed, hidden, or none.
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.

Values are -1 or 0.
timeout string

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

Values are -1 or 0.

application/json

Body

data_retention 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.
downsampling object
Hide downsampling attribute Show downsampling attribute object
- rounds array[object] Required
  
  The list of downsampling rounds to execute as part of this downsampling configuration
  Hide rounds attributes Show rounds attributes object
  
  after string Required
  
  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.
  
  config object Required
  
  Hide config attribute Show config attribute object
  
  fixed_interval string Required
  
  A date histogram interval. Similar to Duration with additional units: w (week), M (month), q (quarter) and y (year)
enabled boolean

If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that's disabled (enabled: false) will have no effect on the data stream.

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 /_data_stream/{name}/_lifecycle

curl \
 --request PUT 'http://api.example.com/_data_stream/{name}/_lifecycle' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"data_retention\": \"7d\"\n}"'

Request examples

{
  "data_retention": "7d"
}

This example configures two downsampling rounds.

{
    "downsampling": [
      {
        "after": "1d",
        "fixed_interval": "10m"
      },
      {
        "after": "7d",
        "fixed_interval": "1d"
      }
    ]
}

Response examples (200)

A successful response for configuring a data stream lifecycle.

{
  "acknowledged": true
}

Get the status for a data stream lifecycle Generally available; Added in 8.11.0

GET /{index}/_lifecycle/explain

Api key auth Basic auth Bearer auth

Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.

External documentation

Path parameters

index string | array[string] Required

The name of the index to explain

Query parameters

include_defaults boolean

indicates if the API should return the default values the system uses for the index's lifecycle
master_timeout string

Specify timeout for connection to master

Values are -1 or 0.

Responses

200 application/json
Hide response attribute Show response attribute object
- indices object Required
  
  Hide indices attribute Show indices attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  index string Required
  
  managed_by_lifecycle boolean Required
  
  index_creation_date_millis number
  
  Time unit for milliseconds
  
  time_since_index_creation 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.
  
  rollover_date_millis number
  
  Time unit for milliseconds
  
  time_since_rollover 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.
  
  lifecycle object
  
  Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions, if asked.
  
  Hide lifecycle attributes Show lifecycle attributes object
  
  data_retention 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.
  
  downsampling object
  
  Hide downsampling attribute Show downsampling attribute object
  
  rounds array[object] Required
  
  The list of downsampling rounds to execute as part of this downsampling configuration
  
  enabled boolean
  
  If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that's disabled (enabled: false) will have no effect on the data stream.
  
  rollover object
  
  Hide rollover attributes Show rollover attributes object
  
  min_age 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_age string
  
  min_docs number
  
  max_docs number
  
  min_size
  
  max_size
  
  min_primary_shard_size
  
  max_primary_shard_size
  
  min_primary_shard_docs number
  
  max_primary_shard_docs number
  
  generation_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.
  
  error string

GET /{index}/_lifecycle/explain

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

Response examples (200)

A successful response from `GET .ds-metrics-2023.03.22-000001/_lifecycle/explain`, which retrieves the lifecycle status for a data stream backing index. If the index is managed by a data stream lifecycle, the API will show the `managed_by_lifecycle` field set to `true` and the rest of the response will contain information about the lifecycle execution status for this index.

{
  "indices": {
    ".ds-metrics-2023.03.22-000001": {
      "index" : ".ds-metrics-2023.03.22-000001",
      "managed_by_lifecycle" : true,
      "index_creation_date_millis" : 1679475563571,
      "time_since_index_creation" : "843ms",
      "rollover_date_millis" : 1679475564293,
      "time_since_rollover" : "121ms",
      "lifecycle" : { },
      "generation_time" : "121ms"
  }
}

The API reports any errors related to the lifecycle execution for the target index.

{
  "indices": {
    ".ds-metrics-2023.03.22-000001": {
      "index" : ".ds-metrics-2023.03.22-000001",
      "managed_by_lifecycle" : true,
      "index_creation_date_millis" : 1679475563571,
      "time_since_index_creation" : "843ms",
      "lifecycle" : {
        "enabled": true
      },
      "error": "{\"type\":\"validation_exception\",\"reason\":\"Validation Failed: 1: this action would add [2] shards, but this cluster
currently has [4]/[3] maximum normal shards open;\"}"
  }
}

Get data stream lifecycle stats Generally available; Added in 8.12.0

GET /_lifecycle/stats

Api key auth Basic auth Bearer auth

Get statistics about the data streams that are managed by a data stream lifecycle.

Required authorization

Cluster privileges: monitor

External documentation

Responses

200 application/json
Hide response attributes Show response attributes object
- data_stream_count number Required
  
  The count of data streams currently being managed by the data stream lifecycle.
- data_streams array[object] Required
  
  Information about the data streams that are managed by the data stream lifecycle.
  
  Hide data_streams attributes Show data_streams attributes object
  
  backing_indices_in_error number Required
  
  The count of the backing indices for the data stream.
  
  backing_indices_in_total number Required
  
  The count of the backing indices for the data stream that have encountered an error.
  
  name string Required
- last_run_duration_in_millis number
  
  Time unit for milliseconds
- time_between_starts_in_millis number
  
  Time unit for milliseconds

GET /_lifecycle/stats

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

Response examples (200)

A successful response for `GET _lifecycle/stats?human&pretty`

{
  "last_run_duration_in_millis": 2,
  "last_run_duration": "2ms",
  "time_between_starts_in_millis": 9998,
  "time_between_starts": "9.99s",
  "data_streams_count": 2,
  "data_streams": [
    {
      "name": "my-data-stream",
      "backing_indices_in_total": 2,
      "backing_indices_in_error": 0
    },
    {
      "name": "my-other-stream",
      "backing_indices_in_total": 2,
      "backing_indices_in_error": 1
    }
  ]
}

Get data streams Generally available; Added in 7.9.0

GET /_data_stream

Api key auth Basic auth Bearer auth

Get information about one or more data streams.

Required authorization

Index privileges: view_index_metadata

Query parameters

expand_wildcards string | array[string]

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

Values are all, open, closed, hidden, or none.
include_defaults boolean

If true, returns all relevant default configurations for the index template.
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.

Values are -1 or 0.
verbose boolean

Whether the maximum timestamp for each data stream should be calculated and returned.

Responses

200 application/json
Hide response attribute Show response attribute object
- data_streams array[object] Required
  
  Hide data_streams attributes Show data_streams attributes object
  
  _meta object
  
  Hide _meta attribute Show _meta attribute object
  
  * object Additional properties
  
  allow_custom_routing boolean
  
  If true, the data stream allows custom routing on write request.
  
  failure_store object
  
  Hide failure_store attributes Show failure_store attributes object
  
  enabled boolean Required
  
  indices array[object] Required
  
  Hide indices attributes Show indices attributes object
  
  index_name string Required
  
  index_uuid string Required
  
  ilm_policy string
  
  managed_by string
  
  Values are Index Lifecycle Management, Data stream lifecycle, or Unmanaged.
  
  prefer_ilm boolean
  
  Indicates if ILM should take precedence over DSL in case both are configured to manage this index.
  
  rollover_on_write boolean Required
  
  generation number Required
  
  Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1.
  
  hidden boolean Required
  
  If true, the data stream is hidden.
  
  ilm_policy string
  
  next_generation_managed_by string Required
  
  Values are Index Lifecycle Management, Data stream lifecycle, or Unmanaged.
  
  prefer_ilm boolean Required
  
  Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.
  
  indices array[object] Required
  
  Array of objects containing information about the data stream’s backing indices. The last item in this array contains information about the stream’s current write index.
  
  Hide indices attributes Show indices attributes object
  
  index_name string Required
  
  index_uuid string Required
  
  ilm_policy string
  
  managed_by string
  
  Values are Index Lifecycle Management, Data stream lifecycle, or Unmanaged.
  
  prefer_ilm boolean
  
  Indicates if ILM should take precedence over DSL in case both are configured to manage this index.
  
  lifecycle object
  
  Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions, if asked.
  
  Hide lifecycle attributes Show lifecycle attributes object
  
  data_retention 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.
  
  downsampling object
  
  Hide downsampling attribute Show downsampling attribute object
  
  rounds array[object] Required
  
  The list of downsampling rounds to execute as part of this downsampling configuration
  
  enabled boolean
  
  If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that's disabled (enabled: false) will have no effect on the data stream.
  
  rollover object
  
  Hide rollover attributes Show rollover attributes object
  
  min_age 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_age string
  
  min_docs number
  
  max_docs number
  
  min_size
  
  max_size
  
  min_primary_shard_size
  
  max_primary_shard_size
  
  min_primary_shard_docs number
  
  max_primary_shard_docs number
  
  name string Required
  
  replicated boolean
  
  If true, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings.
  
  rollover_on_write boolean Required
  
  If true, the next write to this data stream will trigger a rollover first and the document will be indexed in the new backing index. If the rollover fails the indexing request will fail too.
  
  status string Required
  
  Values are green, GREEN, yellow, YELLOW, red, or RED.
  
  system boolean Generally available; Added in 7.10.0
  
  If true, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction.
  
  template string Required
  
  timestamp_field object Required
  
  Hide timestamp_field attribute Show timestamp_field attribute object
  
  name string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

GET /_data_stream

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

Response examples (200)

A successful response for retrieving information about a data stream.

{
  "data_streams": [
    {
      "name": "my-data-stream",
      "timestamp_field": {
        "name": "@timestamp"
      },
      "indices": [
        {
          "index_name": ".ds-my-data-stream-2099.03.07-000001",
          "index_uuid": "xCEhwsp8Tey0-FLNFYVwSg",
          "prefer_ilm": true,
          "ilm_policy": "my-lifecycle-policy",
          "managed_by": "Index Lifecycle Management"
        },
        {
          "index_name": ".ds-my-data-stream-2099.03.08-000002",
          "index_uuid": "PA_JquKGSiKcAKBA8DJ5gw",
          "prefer_ilm": true,
          "ilm_policy": "my-lifecycle-policy",
          "managed_by": "Index Lifecycle Management"
        }
      ],
      "generation": 2,
      "_meta": {
        "my-meta-field": "foo"
      },
      "status": "GREEN",
      "next_generation_managed_by": "Index Lifecycle Management",
      "prefer_ilm": true,
      "template": "my-index-template",
      "ilm_policy": "my-lifecycle-policy",
      "hidden": false,
      "system": false,
      "allow_custom_routing": false,
      "replicated": false,
      "rollover_on_write": false
    },
    {
      "name": "my-data-stream-two",
      "timestamp_field": {
        "name": "@timestamp"
      },
      "indices": [
        {
          "index_name": ".ds-my-data-stream-two-2099.03.08-000001",
          "index_uuid": "3liBu2SYS5axasRt6fUIpA",
          "prefer_ilm": true,
          "ilm_policy": "my-lifecycle-policy",
          "managed_by": "Index Lifecycle Management"
        }
      ],
      "generation": 1,
      "_meta": {
        "my-meta-field": "foo"
      },
      "status": "YELLOW",
      "next_generation_managed_by": "Index Lifecycle Management",
      "prefer_ilm": true,
      "template": "my-index-template",
      "ilm_policy": "my-lifecycle-policy",
      "hidden": false,
      "system": false,
      "allow_custom_routing": false,
      "replicated": false,
      "rollover_on_write": false
    }
  ]
}

Convert an index alias to a data stream Generally available; Added in 7.9.0

POST /_data_stream/_migrate/{name}

Api key auth Basic auth Bearer auth

Converts an index alias to a data stream. You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a @timestamp field mapping of a date or date_nanos field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream.

Required authorization

Index privileges: manage

Path parameters

name string Required

Name of the index alias to convert to a data stream.

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.

Values are -1 or 0.
timeout string

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

Values are -1 or 0.

Responses

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

POST /_data_stream/_migrate/{name}

curl \
 --request POST 'http://api.example.com/_data_stream/_migrate/{name}' \
 --header "Authorization: $API_KEY"

Update data streams Generally available; Added in 7.16.0

POST /_data_stream/_modify

Api key auth Basic auth Bearer auth

Performs one or more data stream modification actions in a single atomic operation.

application/json

Body Required

actions array[object] Required

Actions to perform.
Hide actions attributes Show actions attributes object
- add_backing_index object
  Hide add_backing_index attributes Show add_backing_index attributes object
  
  data_stream string Required
  
  index string Required
- remove_backing_index object
  Hide remove_backing_index attributes Show remove_backing_index attributes object
  
  data_stream string Required
  
  index string Required

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.

POST /_data_stream/_modify

curl \
 --request POST 'http://api.example.com/_data_stream/_modify' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"actions\": [\n    {\n      \"remove_backing_index\": {\n        \"data_stream\": \"my-data-stream\",\n        \"index\": \".ds-my-data-stream-2023.07.26-000001\"\n      }\n    },\n    {\n      \"add_backing_index\": {\n        \"data_stream\": \"my-data-stream\",\n        \"index\": \".ds-my-data-stream-2023.07.26-000001-downsample\"\n      }\n    }\n  ]\n}"'

Request example

An example body for a `POST _data_stream/_modify` request.

{
  "actions": [
    {
      "remove_backing_index": {
        "data_stream": "my-data-stream",
        "index": ".ds-my-data-stream-2023.07.26-000001"
      }
    },
    {
      "add_backing_index": {
        "data_stream": "my-data-stream",
        "index": ".ds-my-data-stream-2023.07.26-000001-downsample"
      }
    }
  ]
}

Bulk index or delete documents Generally available

PUT /{index}/_bulk

Api key auth Basic auth Bearer auth

Perform multiple index, create, delete, and update actions in a single request. This reduces overhead and can greatly increase indexing speed.

If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:

To use the create action, you must have the create_doc, create, index, or write index privilege. Data streams support only the create action.
To use the index action, you must have the create, index, or write index privilege.
To use the delete action, you must have the delete or write index privilege.
To use the update action, you must have the index or write index privilege.
To automatically create a data stream or index with a bulk API request, you must have the auto_configure, create_index, or manage index privilege.
To make the result of a bulk operation visible to search using the refresh parameter, you must have the maintenance or manage index privilege.

Automatic data stream creation requires a matching index template with data stream enabled.

The actions are specified in the request body using a newline delimited JSON (NDJSON) structure:

action_and_meta_data\n
optional_source\n
action_and_meta_data\n
optional_source\n
....
action_and_meta_data\n
optional_source\n

The index and create actions expect a source on the next line and have the same semantics as the op_type parameter in the standard index API. A create action fails if a document with the same ID already exists in the target An index action adds or replaces a document as necessary.

NOTE: Data streams support only the create action. To update or delete a document in a data stream, you must target the backing index containing the document.

An update action expects that the partial doc, upsert, and script and its options are specified on the next line.

A delete action does not expect a source on the next line and has the same semantics as the standard delete API.

NOTE: The final line of data must end with a newline character (\n). Each newline character may be preceded by a carriage return (\r). When sending NDJSON data to the _bulk endpoint, use a Content-Type header of application/json or application/x-ndjson. Because this format uses literal newline characters (\n) as delimiters, make sure that the JSON actions and sources are not pretty printed.

If you provide a target in the request path, it is used for any actions that don't explicitly specify an _index argument.

A note on the format: the idea here is to make processing as fast as possible. As some of the actions are redirected to other shards on other nodes, only action_meta_data is parsed on the receiving node side.

Client libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.

There is no "correct" number of actions to perform in a single bulk request. Experiment with different settings to find the optimal size for your particular workload. Note that Elasticsearch limits the maximum size of a HTTP request to 100mb by default so clients must ensure that no request exceeds this size. It is not possible to index a single document that exceeds the size limit, so you must pre-process any such documents into smaller pieces before sending them to Elasticsearch. For instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch.

Client suppport for bulk requests

Some of the officially supported clients provide helpers to assist with bulk requests and reindexing:

Go: Check out esutil.BulkIndexer
Perl: Check out Search::Elasticsearch::Client::5_0::Bulk and Search::Elasticsearch::Client::5_0::Scroll
Python: Check out elasticsearch.helpers.*
JavaScript: Check out client.helpers.*
.NET: Check out BulkAllObservable
PHP: Check out bulk indexing.

Submitting bulk requests with cURL

If you're providing text file input to curl, you must use the --data-binary flag instead of plain -d. The latter doesn't preserve newlines. For example:

$ cat requests
{ "index" : { "_index" : "test", "_id" : "1" } }
{ "field1" : "value1" }
$ curl -s -H "Content-Type: application/x-ndjson" -XPOST localhost:9200/_bulk --data-binary "@requests"; echo
{"took":7, "errors": false, "items":[{"index":{"_index":"test","_id":"1","_version":1,"result":"created","forced_refresh":false}}]}

Optimistic concurrency control

Each index and delete action within a bulk API call may include the if_seq_no and if_primary_term parameters in their respective action and meta data lines. The if_seq_no and if_primary_term parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.

Versioning

Each bulk item can include the version value using the version field. It automatically follows the behavior of the index or delete operation based on the _version mapping. It also support the version_type.

Routing

Each bulk item can include the routing value using the routing field. It automatically follows the behavior of the index or delete operation based on the _routing mapping.

NOTE: Data streams do not support custom routing unless they were created with the allow_custom_routing setting enabled in the template.

Wait for active shards

When making bulk calls, you can set the wait_for_active_shards parameter to require a minimum number of shard copies to be active before starting to process the bulk request.

Refresh

Control when the changes made by this request are visible to search.

NOTE: Only the shards that receive the bulk request will be affected by refresh. Imagine a _bulk?refresh=wait_for request with three documents in it that happen to be routed to different shards in an index with five shards. The request will only wait for those three shards to refresh. The other two shards that make up the index do not participate in the _bulk request at all.

Path parameters

index string Required

The name of the data stream, index, or index alias to perform bulk actions on.

Query parameters

include_source_on_error boolean

True or false if to include the document source in the error message in case of parsing errors.
list_executed_pipelines boolean

If true, the response will include the ingest pipelines that were run for each index or create.
pipeline string

The pipeline identifier to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to _none turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter.
refresh string

If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If wait_for, wait for a refresh to make this operation visible to search. If false, do nothing with refreshes. Valid values: true, false, wait_for.

Values are true, false, or wait_for.
routing string

A custom value that is used to route operations to a specific shard.
_source boolean | string | array[string]

Indicates whether to return the _source field (true or false) or contains a list of fields to return.
_source_excludes string | array[string]

A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. If the _source parameter is false, this parameter is ignored.
_source_includes string | array[string]

A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.
timeout string

The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards. The default is 1m (one minute), which guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.

Values are -1 or 0.
wait_for_active_shards number | string

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). The default is 1, which waits for each primary shard to be active.

Values are all or index-setting.
require_alias boolean

If true, the request's actions must target an index alias.
require_data_stream boolean

If true, the request's actions must target a data stream (existing or to be created).

application/json

Body object Required

index object
Hide index attributes Show index attributes object
- _id string
- _index string
- routing string
- if_primary_term number
- if_seq_no number
- version number
- version_type string
  
  Values are internal, external, external_gte, or force.
- dynamic_templates object
  
  A map from the full name of fields to the name of dynamic templates. It defaults to an empty map. If a name matches a dynamic template, that template will be applied regardless of other match predicates defined in the template. If a field is already defined in the mapping, then this parameter won't be used.
  Hide dynamic_templates attribute Show dynamic_templates attribute object
  
  * string Additional properties
- pipeline string
  
  The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to _none turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter.
- require_alias boolean
  
  If true, the request's actions must target an index alias.
create object
Hide create attributes Show create attributes object
- _id string
- _index string
- routing string
- if_primary_term number
- if_seq_no number
- version number
- version_type string
  
  Values are internal, external, external_gte, or force.
- dynamic_templates object
  
  A map from the full name of fields to the name of dynamic templates. It defaults to an empty map. If a name matches a dynamic template, that template will be applied regardless of other match predicates defined in the template. If a field is already defined in the mapping, then this parameter won't be used.
  Hide dynamic_templates attribute Show dynamic_templates attribute object
  
  * string Additional properties
- pipeline string
  
  The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to _none turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter.
- require_alias boolean
  
  If true, the request's actions must target an index alias.
update object
Hide update attributes Show update attributes object
- _id string
- _index string
- routing string
- if_primary_term number
- if_seq_no number
- version number
- version_type string
  
  Values are internal, external, external_gte, or force.
- require_alias boolean
  
  If true, the request's actions must target an index alias.
- retry_on_conflict number
  
  The number of times an update should be retried in the case of a version conflict.
delete object
Hide delete attributes Show delete attributes object
- _id string
- _index string
- routing string
- if_primary_term number
- if_seq_no number
- version number
- version_type string
  
  Values are internal, external, external_gte, or force.

detect_noop boolean

If true, the result in the response is set to 'noop' when no changes to the document occur.
doc object

A partial update to an existing document.
doc_as_upsert boolean

Set to true to use the contents of doc as the value of upsert.
script object
Hide script attributes Show script attributes object
- source string
  
  The script source.
- id string
- params object
  
  Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.
  Hide params attribute Show params attribute object
  
  * object Additional properties
- lang string
  
  Any of:
  ScriptLanguage string ScriptLanguage string
  
  Values are painless, expression, mustache, or java.
- options object
  Hide options attribute Show options attribute object
  
  * string Additional properties
scripted_upsert boolean

Set to true to run the script whether or not the document exists.
_source boolean | object

Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
One of:
SourceConfig boolean SourceFilter object
Hide attributes Show attributes

excludes string | array[string]

includes string | array[string]
upsert object

If the document does not already exist, the contents of upsert are inserted as a new document. If the document exists, the script is run.

Responses

200 application/json
Hide response attributes Show response attributes object
- errors boolean Required
  
  If true, one or more of the operations in the bulk request did not complete successfully.
- items array[object] Required
  
  The result of each operation in the bulk request, in the order they were submitted.
  
  Hide items attribute Show items attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  _id string | null
  
  The document ID associated with the operation.
  
  One of:
  string-1 string string-2 string | null
  
  _index string Required
  
  The name of the index associated with the operation. If the operation targeted a data stream, this is the backing index into which the document was written.
  
  status number Required
  
  The HTTP status code returned for the operation.
  
  failure_store string
  
  Values are not_applicable_or_unknown, used, not_enabled, or failed.
  
  error object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Hide error attributes Show error attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  One of:
  string-1 string string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  _primary_term number
  
  The primary term assigned to the document for the operation. This property is returned only for successful operations.
  
  result string
  
  The result of the operation. Successful values are created, deleted, and updated.
  
  _seq_no number
  
  _shards object
  
  Hide _shards attributes Show _shards attributes object
  
  failed number Required
  
  successful number Required
  
  total number Required
  
  failures array[object]
  
  skipped number
  
  _version number
  
  forced_refresh boolean
  
  get object
  
  Hide get attributes Show get attributes object
  
  fields object
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  found boolean Required
  
  _seq_no number
  
  _primary_term number
  
  _routing string
  
  _source object
  
  Hide _source attribute Show _source attribute object
  
  * object Additional properties
- took number Required
  
  The length of time, in milliseconds, it took to process the bulk request.
- ingest_took number

PUT /{index}/_bulk

curl \
 --request PUT 'http://api.example.com/{index}/_bulk' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{ \"index\" : { \"_index\" : \"test\", \"_id\" : \"1\" } }\n{ \"field1\" : \"value1\" }\n{ \"delete\" : { \"_index\" : \"test\", \"_id\" : \"2\" } }\n{ \"create\" : { \"_index\" : \"test\", \"_id\" : \"3\" } }\n{ \"field1\" : \"value3\" }\n{ \"update\" : {\"_id\" : \"1\", \"_index\" : \"test\"} }\n{ \"doc\" : {\"field2\" : \"value2\"} }"'

Request examples

Run `POST _bulk` to perform multiple operations.

{ "index" : { "_index" : "test", "_id" : "1" } }
{ "field1" : "value1" }
{ "delete" : { "_index" : "test", "_id" : "2" } }
{ "create" : { "_index" : "test", "_id" : "3" } }
{ "field1" : "value3" }
{ "update" : {"_id" : "1", "_index" : "test"} }
{ "doc" : {"field2" : "value2"} }

When you run `POST _bulk` and use the `update` action, you can use `retry_on_conflict` as a field in the action itself (not in the extra payload line) to specify how many times an update should be retried in the case of a version conflict.

{ "update" : {"_id" : "1", "_index" : "index1", "retry_on_conflict" : 3} }
{ "doc" : {"field" : "value"} }
{ "update" : { "_id" : "0", "_index" : "index1", "retry_on_conflict" : 3} }
{ "script" : { "source": "ctx._source.counter += params.param1", "lang" : "painless", "params" : {"param1" : 1}}, "upsert" : {"counter" : 1}}
{ "update" : {"_id" : "2", "_index" : "index1", "retry_on_conflict" : 3} }
{ "doc" : {"field" : "value"}, "doc_as_upsert" : true }
{ "update" : {"_id" : "3", "_index" : "index1", "_source" : true} }
{ "doc" : {"field" : "value"} }
{ "update" : {"_id" : "4", "_index" : "index1"} }
{ "doc" : {"field" : "value"}, "_source": true}

To return only information about failed operations, run `POST /_bulk?filter_path=items.*.error`.

{ "update": {"_id": "5", "_index": "index1"} }
{ "doc": {"my_field": "foo"} }
{ "update": {"_id": "6", "_index": "index1"} }
{ "doc": {"my_field": "foo"} }
{ "create": {"_id": "7", "_index": "index1"} }
{ "my_field": "foo" }

Run `POST /_bulk` to perform a bulk request that consists of index and create actions with the `dynamic_templates` parameter. The bulk request creates two new fields `work_location` and `home_location` with type `geo_point` according to the `dynamic_templates` parameter. However, the `raw_location` field is created using default dynamic mapping rules, as a text field in that case since it is supplied as a string in the JSON document.

{ "index" : { "_index" : "my_index", "_id" : "1", "dynamic_templates": {"work_location": "geo_point"}} }
{ "field" : "value1", "work_location": "41.12,-71.34", "raw_location": "41.12,-71.34"}
{ "create" : { "_index" : "my_index", "_id" : "2", "dynamic_templates": {"home_location": "geo_point"}} }
{ "field" : "value2", "home_location": "41.12,-71.34"}

Response examples (200)

{
   "took": 30,
   "errors": false,
   "items": [
      {
         "index": {
            "_index": "test",
            "_id": "1",
            "_version": 1,
            "result": "created",
            "_shards": {
               "total": 2,
               "successful": 1,
               "failed": 0
            },
            "status": 201,
            "_seq_no" : 0,
            "_primary_term": 1
         }
      },
      {
         "delete": {
            "_index": "test",
            "_id": "2",
            "_version": 1,
            "result": "not_found",
            "_shards": {
               "total": 2,
               "successful": 1,
               "failed": 0
            },
            "status": 404,
            "_seq_no" : 1,
            "_primary_term" : 2
         }
      },
      {
         "create": {
            "_index": "test",
            "_id": "3",
            "_version": 1,
            "result": "created",
            "_shards": {
               "total": 2,
               "successful": 1,
               "failed": 0
            },
            "status": 201,
            "_seq_no" : 2,
            "_primary_term" : 3
         }
      },
      {
         "update": {
            "_index": "test",
            "_id": "1",
            "_version": 2,
            "result": "updated",
            "_shards": {
                "total": 2,
                "successful": 1,
                "failed": 0
            },
            "status": 200,
            "_seq_no" : 3,
            "_primary_term" : 4
         }
      }
   ]
}

If you run `POST /_bulk` with operations that update non-existent documents, the operations cannot complete successfully. The API returns a response with an `errors` property value `true`. The response also includes an error object for any failed operations. The error object contains additional information about the failure, such as the error type and reason.

{
  "took": 486,
  "errors": true,
  "items": [
    {
      "update": {
        "_index": "index1",
        "_id": "5",
        "status": 404,
        "error": {
          "type": "document_missing_exception",
          "reason": "[5]: document missing",
          "index_uuid": "aAsFqTI0Tc2W0LCWgPNrOA",
          "shard": "0",
          "index": "index1"
        }
      }
    },
    {
      "update": {
        "_index": "index1",
        "_id": "6",
        "status": 404,
        "error": {
          "type": "document_missing_exception",
          "reason": "[6]: document missing",
          "index_uuid": "aAsFqTI0Tc2W0LCWgPNrOA",
          "shard": "0",
          "index": "index1"
        }
      }
    },
    {
      "create": {
        "_index": "index1",
        "_id": "7",
        "_version": 1,
        "result": "created",
        "_shards": {
          "total": 2,
          "successful": 1,
          "failed": 0
        },
        "_seq_no": 0,
        "_primary_term": 1,
        "status": 201
      }
    }
  ]
}

An example response from `POST /_bulk?filter_path=items.*.error`, which returns only information about failed operations.

{
  "items": [
    {
      "update": {
        "error": {
          "type": "document_missing_exception",
          "reason": "[5]: document missing",
          "index_uuid": "aAsFqTI0Tc2W0LCWgPNrOA",
          "shard": "0",
          "index": "index1"
        }
      }
    },
    {
      "update": {
        "error": {
          "type": "document_missing_exception",
          "reason": "[6]: document missing",
          "index_uuid": "aAsFqTI0Tc2W0LCWgPNrOA",
          "shard": "0",
          "index": "index1"
        }
      }
    }
  ]
}

Bulk index or delete documents Generally available

POST /{index}/_bulk

Api key auth Basic auth Bearer auth

Perform multiple index, create, delete, and update actions in a single request. This reduces overhead and can greatly increase indexing speed.

If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:

To use the create action, you must have the create_doc, create, index, or write index privilege. Data streams support only the create action.
To use the index action, you must have the create, index, or write index privilege.
To use the delete action, you must have the delete or write index privilege.
To use the update action, you must have the index or write index privilege.
To automatically create a data stream or index with a bulk API request, you must have the auto_configure, create_index, or manage index privilege.
To make the result of a bulk operation visible to search using the refresh parameter, you must have the maintenance or manage index privilege.

Automatic data stream creation requires a matching index template with data stream enabled.

The actions are specified in the request body using a newline delimited JSON (NDJSON) structure:

action_and_meta_data\n
optional_source\n
action_and_meta_data\n
optional_source\n
....
action_and_meta_data\n
optional_source\n