** *`wait_for_completion_timeout` (Optional, string | -1 | 0)*: Blocks and waits until the search is completed up to a certain timeout.
When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster.
** *`keep_on_completion` (Optional, boolean)*: If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.
** *`keep_alive` (Optional, string | -1 | 0)*: Specifies how long the async search needs to be available.
Ongoing async searches and any saved search results are deleted after this period.
** *`allow_no_indices` (Optional, 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)
** *`allow_partial_search_results` (Optional, boolean)*: Indicate if an error should be returned if there is a partial search failure or timeout
** *`analyzer` (Optional, string)*: The analyzer to use for the query string
@ -1660,7 +1659,6 @@ A partial reduction is performed every time the coordinating node has received a
** *`lenient` (Optional, boolean)*: Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
** *`max_concurrent_shard_requests` (Optional, number)*: The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
** *`preference` (Optional, string)*: Specify the node or shard the operation should be performed on (default: random)
** *`pre_filter_shard_size` (Optional, number)*: The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped.
** *`request_cache` (Optional, boolean)*: Specify if request cache should be used for this request or not, defaults to true
** *`routing` (Optional, string)*: A list of specific routing values
** *`search_type` (Optional, Enum("query_then_fetch" | "dfs_query_then_fetch"))*: Search operation type
@ -1794,7 +1792,8 @@ client.cat.aliases({ ... })
[discrete]
==== allocation
Provides a snapshot of the number of shards allocated to each data node and their disk space.
Get shard allocation information.
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.
{ref}/cat-allocation.html[Endpoint documentation]
@ -1863,7 +1862,8 @@ Supports wildcards (`*`). To target all data streams and indices, omit this para
[discrete]
==== fielddata
Returns the amount of heap memory currently used by the field data cache on every data node in the cluster.
Get field data cache information.
Get the amount of heap memory currently used by the field data cache on every data node 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 nodes stats API.
@ -1883,7 +1883,7 @@ To retrieve all fields, omit this parameter.
[discrete]
==== health
Returns the health status of a cluster, similar to the cluster health API.
Get the cluster health status.
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.
@ -1958,7 +1958,8 @@ Supports wildcards (`*`). To target all data streams and indices, omit this para
[discrete]
==== master
Returns information about the master node, including the ID, bound IP address, and name.
Get master node information.
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.
{ref}/cat-master.html[Endpoint documentation]
@ -2107,7 +2108,8 @@ If `false`, the API returns a 404 status code when there are no matches or only
[discrete]
==== nodeattrs
Returns information about custom node attributes.
Get node attribute information.
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.
{ref}/cat-nodeattrs.html[Endpoint documentation]
@ -2127,7 +2129,8 @@ node will send requests for further information to each selected node.
[discrete]
==== nodes
Returns information about the nodes in a cluster.
Get node information.
Get information about the nodes in a cluster.
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
{ref}/cat-nodes.html[Endpoint documentation]
@ -2146,7 +2149,8 @@ client.cat.nodes({ ... })
[discrete]
==== pending_tasks
Returns cluster-level changes that have not yet been executed.
Get pending task information.
Get information about cluster-level changes that have not yet taken effect.
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.
@ -2166,7 +2170,8 @@ node will send requests for further information to each selected node.
[discrete]
==== plugins
Returns a list of plugins running on each node of a cluster.
Get plugin information.
Get a list of plugins running on each node of a cluster.
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
{ref}/cat-plugins.html[Endpoint documentation]
@ -2186,7 +2191,8 @@ node will send requests for further information to each selected node.
[discrete]
==== recovery
Returns information about ongoing and completed shard recoveries.
Get shard recovery information.
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.
@ -2209,7 +2215,8 @@ Supports wildcards (`*`). To target all data streams and indices, omit this para
[discrete]
==== repositories
Returns the snapshot repositories for a cluster.
Get snapshot repository information.
Get a list of snapshot repositories for a cluster.
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.
Returns low-level information about the Lucene segments in index shards.
Get segment information.
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.
@ -2246,7 +2254,8 @@ node will send requests for further information to each selected node.
[discrete]
==== shards
Returns information about the shards in a cluster.
Get shard information.
Get information about the shards in a cluster.
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.
@ -2267,7 +2276,8 @@ To target all data streams and indices, omit this parameter or use `*` or `_all`
[discrete]
==== snapshots
Returns information about the snapshots stored in one or more repositories.
Get snapshot information
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.
@ -2289,7 +2299,8 @@ If any repository fails during the request, Elasticsearch returns an error.
[discrete]
==== tasks
Returns information about tasks currently executing in the cluster.
Get task information.
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.
{ref}/tasks.html[Endpoint documentation]
@ -2309,7 +2320,8 @@ client.cat.tasks({ ... })
[discrete]
==== templates
Returns information about index templates in a cluster.
Get index template information.
Get information about the index templates in a cluster.
You can use index templates to apply index settings and field mappings to new indices at creation.
IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.
@ -2332,7 +2344,8 @@ node will send requests for further information to each selected node.
[discrete]
==== thread_pool
Returns thread pool statistics for each node in a cluster.
Get thread pool statistics.
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.
@ -2356,8 +2369,8 @@ node will send requests for further information to each selected node.
[discrete]
==== transforms
Get transforms.
Returns configuration and usage information about transforms.
Get transform information.
Get configuration and usage information about transforms.
CAT APIs are only intended for human consumption using the Kibana
console or command line. They are not intended for use by applications. For
@ -3622,7 +3635,8 @@ client.enrich.deletePolicy({ name })
[discrete]
==== execute_policy
Creates the enrich index for an existing enrich policy.
Run an enrich policy.
Create the enrich index for an existing enrich policy.
@ -3886,9 +3908,10 @@ will cause Elasticsearch to immediately return the current global checkpoints.
[discrete]
==== msearch
Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request.
The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it
supports the wait_for_checkpoints parameter.
Run multiple Fleet searches.
Run several Fleet searches with a single API request.
The API follows the same structure as the multi search API.
However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.
[source,ts]
----
client.fleet.msearch({ ... })
@ -3920,8 +3943,9 @@ which is true by default.
[discrete]
==== search
The purpose of the fleet search api is to provide a search api where the search will only be executed
after provided checkpoint has been processed and is visible for searches inside of Elasticsearch.
Run a Fleet search.
The purpose of the Fleet search API is to provide an API where the search will be run only
after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.
[source,ts]
----
client.fleet.search({ index })
@ -4024,7 +4048,12 @@ which is true by default.
=== graph
[discrete]
==== explore
Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.
Explore graph analytics.
Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
The easiest way to understand the behavior of this API is to use the Graph UI to explore connections.
An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.
Subsequent requests enable you to spider out from one more vertices of interest.
You can exclude vertices that have already been returned.
** *`ignore_unavailable` (Optional, boolean)*: If `false`, requests that include a missing data stream or index in the target indices or data streams return an error.
** *`master_timeout` (Optional, string | -1 | 0)*: 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.
[discrete]
==== exists_index_template
Returns information about whether a particular index template exists.
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Elastic Machine