[[api-reference]]
////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////
== API Reference

[discrete]
=== bulk
Allows to perform multiple index/update/delete operations in a single request.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-bulk.html[Endpoint documentation]
[source,ts]
----
client.bulk(...)
----

[discrete]
=== clear_scroll
Explicitly clears the search context for a scroll.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/clear-scroll-api.html[Endpoint documentation]
[source,ts]
----
client.clearScroll(...)
----

[discrete]
=== close_point_in_time
Close a point in time

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/point-in-time-api.html[Endpoint documentation]
[source,ts]
----
client.closePointInTime(...)
----

[discrete]
=== count
Returns number of documents matching a query.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/search-count.html[Endpoint documentation]
[source,ts]
----
client.count(...)
----

[discrete]
=== create
Creates a new document in the index.

Returns a 409 response when a document with a same ID already exists in the index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-index_.html[Endpoint documentation]
[source,ts]
----
client.create(...)
----

[discrete]
=== delete
Removes a document from the index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-delete.html[Endpoint documentation]
[source,ts]
----
client.delete(...)
----

[discrete]
=== delete_by_query
Deletes documents matching the provided query.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-delete-by-query.html[Endpoint documentation]
[source,ts]
----
client.deleteByQuery(...)
----

[discrete]
=== delete_by_query_rethrottle
Changes the number of requests per second for a particular Delete By Query operation.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-delete-by-query.html[Endpoint documentation]
[source,ts]
----
client.deleteByQueryRethrottle(...)
----

[discrete]
=== delete_script
Deletes a script.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-scripting.html[Endpoint documentation]
[source,ts]
----
client.deleteScript(...)
----

[discrete]
=== exists
Returns information about whether a document exists in an index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-get.html[Endpoint documentation]
[source,ts]
----
client.exists(...)
----

[discrete]
=== exists_source
Returns information about whether a document source exists in an index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-get.html[Endpoint documentation]
[source,ts]
----
client.existsSource(...)
----

[discrete]
=== explain
Returns information about why a specific matches (or doesn't match) a query.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/search-explain.html[Endpoint documentation]
[source,ts]
----
client.explain(...)
----

[discrete]
=== field_caps
Returns the information about the capabilities of fields among multiple indices.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/search-field-caps.html[Endpoint documentation]
[source,ts]
----
client.fieldCaps(...)
----

[discrete]
=== get
Returns a document.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-get.html[Endpoint documentation]
[source,ts]
----
client.get(...)
----

[discrete]
=== get_script
Returns a script.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-scripting.html[Endpoint documentation]
[source,ts]
----
client.getScript(...)
----

[discrete]
=== get_script_context
Returns all script contexts.

https://www.elastic.co/guide/en/elasticsearch/painless/8.7/painless-contexts.html[Endpoint documentation]
[source,ts]
----
client.getScriptContext(...)
----

[discrete]
=== get_script_languages
Returns available script types, languages and contexts

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-scripting.html[Endpoint documentation]
[source,ts]
----
client.getScriptLanguages(...)
----

[discrete]
=== get_source
Returns the source of a document.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-get.html[Endpoint documentation]
[source,ts]
----
client.getSource(...)
----

[discrete]
=== health_report
Returns the health of the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/health-api.html[Endpoint documentation]
[source,ts]
----
client.healthReport(...)
----

[discrete]
=== index
Creates or updates a document in an index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-index_.html[Endpoint documentation]
[source,ts]
----
client.index(...)
----

[discrete]
=== info
Returns basic information about the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/index.html[Endpoint documentation]
[source,ts]
----
client.info(...)
----

[discrete]
=== knn_search
Performs a kNN search.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/search-search.html[Endpoint documentation]
[source,ts]
----
client.knnSearch(...)
----

[discrete]
=== mget
Allows to get multiple documents in one request.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-multi-get.html[Endpoint documentation]
[source,ts]
----
client.mget(...)
----

[discrete]
=== msearch
Allows to execute several search operations in one request.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/search-multi-search.html[Endpoint documentation]
[source,ts]
----
client.msearch(...)
----

[discrete]
=== msearch_template
Allows to execute several search template operations in one request.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/search-multi-search.html[Endpoint documentation]
[source,ts]
----
client.msearchTemplate(...)
----

[discrete]
=== mtermvectors
Returns multiple termvectors in one request.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-multi-termvectors.html[Endpoint documentation]
[source,ts]
----
client.mtermvectors(...)
----

[discrete]
=== open_point_in_time
Open a point in time that can be used in subsequent searches

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/point-in-time-api.html[Endpoint documentation]
[source,ts]
----
client.openPointInTime(...)
----

[discrete]
=== ping
Returns whether the cluster is running.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/index.html[Endpoint documentation]
[source,ts]
----
client.ping(...)
----

[discrete]
=== put_script
Creates or updates a script.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-scripting.html[Endpoint documentation]
[source,ts]
----
client.putScript(...)
----

[discrete]
=== rank_eval
Allows to evaluate the quality of ranked search results over a set of typical search queries

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/search-rank-eval.html[Endpoint documentation]
[source,ts]
----
client.rankEval(...)
----

[discrete]
=== reindex
Allows to copy documents from one index to another, optionally filtering the source
documents by a query, changing the destination index settings, or fetching the
documents from a remote cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-reindex.html[Endpoint documentation]
[source,ts]
----
client.reindex(...)
----

[discrete]
=== reindex_rethrottle
Changes the number of requests per second for a particular Reindex operation.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-reindex.html[Endpoint documentation]
[source,ts]
----
client.reindexRethrottle(...)
----

[discrete]
=== render_search_template
Allows to use the Mustache language to pre-render a search definition.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/render-search-template-api.html[Endpoint documentation]
[source,ts]
----
client.renderSearchTemplate(...)
----

[discrete]
=== scripts_painless_execute
Allows an arbitrary script to be executed and a result to be returned

https://www.elastic.co/guide/en/elasticsearch/painless/8.7/painless-execute-api.html[Endpoint documentation]
[source,ts]
----
client.scriptsPainlessExecute(...)
----

[discrete]
=== scroll
Allows to retrieve a large numbers of results from a single search request.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/search-request-body.html#request-body-search-scroll[Endpoint documentation]
[source,ts]
----
client.scroll(...)
----

[discrete]
=== search
Returns results matching a query.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/search-search.html[Endpoint documentation]
[source,ts]
----
client.search(...)
----

[discrete]
=== search_mvt
Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/search-vector-tile-api.html[Endpoint documentation]
[source,ts]
----
client.searchMvt(...)
----

[discrete]
=== search_shards
Returns information about the indices and shards that a search request would be executed against.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/search-shards.html[Endpoint documentation]
[source,ts]
----
client.searchShards(...)
----

[discrete]
=== search_template
Allows to use the Mustache language to pre-render a search definition.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/search-template.html[Endpoint documentation]
[source,ts]
----
client.searchTemplate(...)
----

[discrete]
=== terms_enum
The terms enum API  can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/search-terms-enum.html[Endpoint documentation]
[source,ts]
----
client.termsEnum(...)
----

[discrete]
=== termvectors
Returns information and statistics about terms in the fields of a particular document.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-termvectors.html[Endpoint documentation]
[source,ts]
----
client.termvectors(...)
----

[discrete]
=== update
Updates a document with a script or partial document.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-update.html[Endpoint documentation]
[source,ts]
----
client.update(...)
----

[discrete]
=== update_by_query
Performs an update on every document in the index without changing the source,
for example to pick up a mapping change.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-update-by-query.html[Endpoint documentation]
[source,ts]
----
client.updateByQuery(...)
----

[discrete]
=== update_by_query_rethrottle
Changes the number of requests per second for a particular Update By Query operation.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-update-by-query.html[Endpoint documentation]
[source,ts]
----
client.updateByQueryRethrottle(...)
----

[discrete]
=== async_search
[discrete]
==== delete
Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/async-search.html[Endpoint documentation]
[source,ts]
----
client.asyncSearch.delete(...)
----

[discrete]
==== get
Retrieves the results of a previously submitted async search request given its ID.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/async-search.html[Endpoint documentation]
[source,ts]
----
client.asyncSearch.get(...)
----

[discrete]
==== status
Retrieves the status of a previously submitted async search request given its ID.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/async-search.html[Endpoint documentation]
[source,ts]
----
client.asyncSearch.status(...)
----

[discrete]
==== submit
Executes a search request asynchronously.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/async-search.html[Endpoint documentation]
[source,ts]
----
client.asyncSearch.submit(...)
----

[discrete]
=== cat
[discrete]
==== aliases
Shows information about currently configured aliases to indices including filter and routing infos.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-alias.html[Endpoint documentation]
[source,ts]
----
client.cat.aliases(...)
----

[discrete]
==== allocation
Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-allocation.html[Endpoint documentation]
[source,ts]
----
client.cat.allocation(...)
----

[discrete]
==== component_templates
Returns information about existing component_templates templates.

[source,ts]
----
client.cat.componentTemplates(...)
----

[discrete]
==== count
Provides quick access to the document count of the entire cluster, or individual indices.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-count.html[Endpoint documentation]
[source,ts]
----
client.cat.count(...)
----

[discrete]
==== fielddata
Shows how much heap memory is currently being used by fielddata on every data node in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-fielddata.html[Endpoint documentation]
[source,ts]
----
client.cat.fielddata(...)
----

[discrete]
==== health
Returns a concise representation of the cluster health.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-health.html[Endpoint documentation]
[source,ts]
----
client.cat.health(...)
----

[discrete]
==== help
Returns help for the Cat APIs.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat.html[Endpoint documentation]
[source,ts]
----
client.cat.help(...)
----

[discrete]
==== indices
Returns information about indices: number of primaries and replicas, document counts, disk size, ...

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-indices.html[Endpoint documentation]
[source,ts]
----
client.cat.indices(...)
----

[discrete]
==== master
Returns information about the master node.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-master.html[Endpoint documentation]
[source,ts]
----
client.cat.master(...)
----

[discrete]
==== ml_data_frame_analytics
Gets configuration and usage information about data frame analytics jobs.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-dfanalytics.html[Endpoint documentation]
[source,ts]
----
client.cat.mlDataFrameAnalytics(...)
----

[discrete]
==== ml_datafeeds
Gets configuration and usage information about datafeeds.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-datafeeds.html[Endpoint documentation]
[source,ts]
----
client.cat.mlDatafeeds(...)
----

[discrete]
==== ml_jobs
Gets configuration and usage information about anomaly detection jobs.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-anomaly-detectors.html[Endpoint documentation]
[source,ts]
----
client.cat.mlJobs(...)
----

[discrete]
==== ml_trained_models
Gets configuration and usage information about inference trained models.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-trained-model.html[Endpoint documentation]
[source,ts]
----
client.cat.mlTrainedModels(...)
----

[discrete]
==== nodeattrs
Returns information about custom node attributes.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-nodeattrs.html[Endpoint documentation]
[source,ts]
----
client.cat.nodeattrs(...)
----

[discrete]
==== nodes
Returns basic statistics about performance of cluster nodes.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-nodes.html[Endpoint documentation]
[source,ts]
----
client.cat.nodes(...)
----

[discrete]
==== pending_tasks
Returns a concise representation of the cluster pending tasks.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-pending-tasks.html[Endpoint documentation]
[source,ts]
----
client.cat.pendingTasks(...)
----

[discrete]
==== plugins
Returns information about installed plugins across nodes node.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-plugins.html[Endpoint documentation]
[source,ts]
----
client.cat.plugins(...)
----

[discrete]
==== recovery
Returns information about index shard recoveries, both on-going completed.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-recovery.html[Endpoint documentation]
[source,ts]
----
client.cat.recovery(...)
----

[discrete]
==== repositories
Returns information about snapshot repositories registered in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-repositories.html[Endpoint documentation]
[source,ts]
----
client.cat.repositories(...)
----

[discrete]
==== segments
Provides low-level information about the segments in the shards of an index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-segments.html[Endpoint documentation]
[source,ts]
----
client.cat.segments(...)
----

[discrete]
==== shards
Provides a detailed view of shard allocation on nodes.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-shards.html[Endpoint documentation]
[source,ts]
----
client.cat.shards(...)
----

[discrete]
==== snapshots
Returns all snapshots in a specific repository.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-snapshots.html[Endpoint documentation]
[source,ts]
----
client.cat.snapshots(...)
----

[discrete]
==== tasks
Returns information about the tasks currently executing on one or more nodes in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/tasks.html[Endpoint documentation]
[source,ts]
----
client.cat.tasks(...)
----

[discrete]
==== templates
Returns information about existing templates.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-templates.html[Endpoint documentation]
[source,ts]
----
client.cat.templates(...)
----

[discrete]
==== thread_pool
Returns cluster-wide thread pool statistics per node.
By default the active, queue and rejected statistics are returned for all thread pools.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-thread-pool.html[Endpoint documentation]
[source,ts]
----
client.cat.threadPool(...)
----

[discrete]
==== transforms
Gets configuration and usage information about transforms.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-transforms.html[Endpoint documentation]
[source,ts]
----
client.cat.transforms(...)
----

[discrete]
=== ccr
[discrete]
==== delete_auto_follow_pattern
Deletes auto-follow patterns.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ccr-delete-auto-follow-pattern.html[Endpoint documentation]
[source,ts]
----
client.ccr.deleteAutoFollowPattern(...)
----

[discrete]
==== follow
Creates a new follower index configured to follow the referenced leader index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ccr-put-follow.html[Endpoint documentation]
[source,ts]
----
client.ccr.follow(...)
----

[discrete]
==== follow_info
Retrieves information about all follower indices, including parameters and status for each follower index

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ccr-get-follow-info.html[Endpoint documentation]
[source,ts]
----
client.ccr.followInfo(...)
----

[discrete]
==== follow_stats
Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ccr-get-follow-stats.html[Endpoint documentation]
[source,ts]
----
client.ccr.followStats(...)
----

[discrete]
==== forget_follower
Removes the follower retention leases from the leader.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ccr-post-forget-follower.html[Endpoint documentation]
[source,ts]
----
client.ccr.forgetFollower(...)
----

[discrete]
==== get_auto_follow_pattern
Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ccr-get-auto-follow-pattern.html[Endpoint documentation]
[source,ts]
----
client.ccr.getAutoFollowPattern(...)
----

[discrete]
==== pause_auto_follow_pattern
Pauses an auto-follow pattern

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ccr-pause-auto-follow-pattern.html[Endpoint documentation]
[source,ts]
----
client.ccr.pauseAutoFollowPattern(...)
----

[discrete]
==== pause_follow
Pauses a follower index. The follower index will not fetch any additional operations from the leader index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ccr-post-pause-follow.html[Endpoint documentation]
[source,ts]
----
client.ccr.pauseFollow(...)
----

[discrete]
==== put_auto_follow_pattern
Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ccr-put-auto-follow-pattern.html[Endpoint documentation]
[source,ts]
----
client.ccr.putAutoFollowPattern(...)
----

[discrete]
==== resume_auto_follow_pattern
Resumes an auto-follow pattern that has been paused

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ccr-resume-auto-follow-pattern.html[Endpoint documentation]
[source,ts]
----
client.ccr.resumeAutoFollowPattern(...)
----

[discrete]
==== resume_follow
Resumes a follower index that has been paused

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ccr-post-resume-follow.html[Endpoint documentation]
[source,ts]
----
client.ccr.resumeFollow(...)
----

[discrete]
==== stats
Gets all stats related to cross-cluster replication.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ccr-get-stats.html[Endpoint documentation]
[source,ts]
----
client.ccr.stats(...)
----

[discrete]
==== unfollow
Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ccr-post-unfollow.html[Endpoint documentation]
[source,ts]
----
client.ccr.unfollow(...)
----

[discrete]
=== cluster
[discrete]
==== allocation_explain
Provides explanations for shard allocations in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cluster-allocation-explain.html[Endpoint documentation]
[source,ts]
----
client.cluster.allocationExplain(...)
----

[discrete]
==== delete_component_template
Deletes a component template

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-component-template.html[Endpoint documentation]
[source,ts]
----
client.cluster.deleteComponentTemplate(...)
----

[discrete]
==== delete_voting_config_exclusions
Clears cluster voting config exclusions.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/voting-config-exclusions.html[Endpoint documentation]
[source,ts]
----
client.cluster.deleteVotingConfigExclusions(...)
----

[discrete]
==== exists_component_template
Returns information about whether a particular component template exist

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-component-template.html[Endpoint documentation]
[source,ts]
----
client.cluster.existsComponentTemplate(...)
----

[discrete]
==== get_component_template
Returns one or more component templates

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-component-template.html[Endpoint documentation]
[source,ts]
----
client.cluster.getComponentTemplate(...)
----

[discrete]
==== get_settings
Returns cluster settings.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cluster-get-settings.html[Endpoint documentation]
[source,ts]
----
client.cluster.getSettings(...)
----

[discrete]
==== health
Returns basic information about the health of the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cluster-health.html[Endpoint documentation]
[source,ts]
----
client.cluster.health(...)
----

[discrete]
==== pending_tasks
Returns a list of any cluster-level changes (e.g. create index, update mapping,
allocate or fail shard) which have not yet been executed.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cluster-pending.html[Endpoint documentation]
[source,ts]
----
client.cluster.pendingTasks(...)
----

[discrete]
==== post_voting_config_exclusions
Updates the cluster voting config exclusions by node ids or node names.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/voting-config-exclusions.html[Endpoint documentation]
[source,ts]
----
client.cluster.postVotingConfigExclusions(...)
----

[discrete]
==== put_component_template
Creates or updates a component template

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-component-template.html[Endpoint documentation]
[source,ts]
----
client.cluster.putComponentTemplate(...)
----

[discrete]
==== put_settings
Updates the cluster settings.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cluster-update-settings.html[Endpoint documentation]
[source,ts]
----
client.cluster.putSettings(...)
----

[discrete]
==== remote_info
Returns the information about configured remote clusters.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cluster-remote-info.html[Endpoint documentation]
[source,ts]
----
client.cluster.remoteInfo(...)
----

[discrete]
==== reroute
Allows to manually change the allocation of individual shards in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cluster-reroute.html[Endpoint documentation]
[source,ts]
----
client.cluster.reroute(...)
----

[discrete]
==== state
Returns a comprehensive information about the state of the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cluster-state.html[Endpoint documentation]
[source,ts]
----
client.cluster.state(...)
----

[discrete]
==== stats
Returns high-level overview of cluster statistics.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cluster-stats.html[Endpoint documentation]
[source,ts]
----
client.cluster.stats(...)
----

[discrete]
=== dangling_indices
[discrete]
==== delete_dangling_index
Deletes the specified dangling index

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-gateway-dangling-indices.html[Endpoint documentation]
[source,ts]
----
client.danglingIndices.deleteDanglingIndex(...)
----

[discrete]
==== import_dangling_index
Imports the specified dangling index

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-gateway-dangling-indices.html[Endpoint documentation]
[source,ts]
----
client.danglingIndices.importDanglingIndex(...)
----

[discrete]
==== list_dangling_indices
Returns all dangling indices.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-gateway-dangling-indices.html[Endpoint documentation]
[source,ts]
----
client.danglingIndices.listDanglingIndices(...)
----

[discrete]
=== enrich
[discrete]
==== delete_policy
Deletes an existing enrich policy and its enrich index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/delete-enrich-policy-api.html[Endpoint documentation]
[source,ts]
----
client.enrich.deletePolicy(...)
----

[discrete]
==== execute_policy
Creates the enrich index for an existing enrich policy.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/execute-enrich-policy-api.html[Endpoint documentation]
[source,ts]
----
client.enrich.executePolicy(...)
----

[discrete]
==== get_policy
Gets information about an enrich policy.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-enrich-policy-api.html[Endpoint documentation]
[source,ts]
----
client.enrich.getPolicy(...)
----

[discrete]
==== put_policy
Creates a new enrich policy.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/put-enrich-policy-api.html[Endpoint documentation]
[source,ts]
----
client.enrich.putPolicy(...)
----

[discrete]
==== stats
Gets enrich coordinator statistics and information about enrich policies that are currently executing.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/enrich-stats-api.html[Endpoint documentation]
[source,ts]
----
client.enrich.stats(...)
----

[discrete]
=== eql
[discrete]
==== delete
Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/eql-search-api.html[Endpoint documentation]
[source,ts]
----
client.eql.delete(...)
----

[discrete]
==== get
Returns async results from previously executed Event Query Language (EQL) search

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/eql-search-api.html[Endpoint documentation]
[source,ts]
----
client.eql.get(...)
----

[discrete]
==== get_status
Returns the status of a previously submitted async or stored Event Query Language (EQL) search

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/eql-search-api.html[Endpoint documentation]
[source,ts]
----
client.eql.getStatus(...)
----

[discrete]
==== search
Returns results matching a query expressed in Event Query Language (EQL)

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/eql-search-api.html[Endpoint documentation]
[source,ts]
----
client.eql.search(...)
----

[discrete]
=== features
[discrete]
==== get_features
Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-features-api.html[Endpoint documentation]
[source,ts]
----
client.features.getFeatures(...)
----

[discrete]
==== reset_features
Resets the internal state of features, usually by deleting system indices

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-snapshots.html[Endpoint documentation]
[source,ts]
----
client.features.resetFeatures(...)
----

[discrete]
=== fleet
[discrete]
==== global_checkpoints
Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-global-checkpoints.html[Endpoint documentation]
[source,ts]
----
client.fleet.globalCheckpoints(...)
----

[discrete]
==== msearch
Multi Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.
[source,ts]
----
client.fleet.msearch(...)
----

[discrete]
==== search
Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.
[source,ts]
----
client.fleet.search(...)
----

[discrete]
=== graph
[discrete]
==== explore
Explore extracted and summarized information about the documents and terms in an index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/graph-explore-api.html[Endpoint documentation]
[source,ts]
----
client.graph.explore(...)
----

[discrete]
=== ilm
[discrete]
==== delete_lifecycle
Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ilm-delete-lifecycle.html[Endpoint documentation]
[source,ts]
----
client.ilm.deleteLifecycle(...)
----

[discrete]
==== explain_lifecycle
Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ilm-explain-lifecycle.html[Endpoint documentation]
[source,ts]
----
client.ilm.explainLifecycle(...)
----

[discrete]
==== get_lifecycle
Returns the specified policy definition. Includes the policy version and last modified date.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ilm-get-lifecycle.html[Endpoint documentation]
[source,ts]
----
client.ilm.getLifecycle(...)
----

[discrete]
==== get_status
Retrieves the current index lifecycle management (ILM) status.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ilm-get-status.html[Endpoint documentation]
[source,ts]
----
client.ilm.getStatus(...)
----

[discrete]
==== migrate_to_data_tiers
Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ilm-migrate-to-data-tiers.html[Endpoint documentation]
[source,ts]
----
client.ilm.migrateToDataTiers(...)
----

[discrete]
==== move_to_step
Manually moves an index into the specified step and executes that step.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ilm-move-to-step.html[Endpoint documentation]
[source,ts]
----
client.ilm.moveToStep(...)
----

[discrete]
==== put_lifecycle
Creates a lifecycle policy

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ilm-put-lifecycle.html[Endpoint documentation]
[source,ts]
----
client.ilm.putLifecycle(...)
----

[discrete]
==== remove_policy
Removes the assigned lifecycle policy and stops managing the specified index

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ilm-remove-policy.html[Endpoint documentation]
[source,ts]
----
client.ilm.removePolicy(...)
----

[discrete]
==== retry
Retries executing the policy for an index that is in the ERROR step.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ilm-retry-policy.html[Endpoint documentation]
[source,ts]
----
client.ilm.retry(...)
----

[discrete]
==== start
Start the index lifecycle management (ILM) plugin.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ilm-start.html[Endpoint documentation]
[source,ts]
----
client.ilm.start(...)
----

[discrete]
==== stop
Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ilm-stop.html[Endpoint documentation]
[source,ts]
----
client.ilm.stop(...)
----

[discrete]
=== indices
[discrete]
==== add_block
Adds a block to an index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/index-modules-blocks.html[Endpoint documentation]
[source,ts]
----
client.indices.addBlock(...)
----

[discrete]
==== analyze
Performs the analysis process on a text and return the tokens breakdown of the text.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-analyze.html[Endpoint documentation]
[source,ts]
----
client.indices.analyze(...)
----

[discrete]
==== clear_cache
Clears all or specific caches for one or more indices.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-clearcache.html[Endpoint documentation]
[source,ts]
----
client.indices.clearCache(...)
----

[discrete]
==== clone
Clones an index

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-clone-index.html[Endpoint documentation]
[source,ts]
----
client.indices.clone(...)
----

[discrete]
==== close
Closes an index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-open-close.html[Endpoint documentation]
[source,ts]
----
client.indices.close(...)
----

[discrete]
==== create
Creates an index with optional settings and mappings.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-create-index.html[Endpoint documentation]
[source,ts]
----
client.indices.create(...)
----

[discrete]
==== create_data_stream
Creates a data stream

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/data-streams.html[Endpoint documentation]
[source,ts]
----
client.indices.createDataStream(...)
----

[discrete]
==== data_streams_stats
Provides statistics on operations happening in a data stream.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/data-streams.html[Endpoint documentation]
[source,ts]
----
client.indices.dataStreamsStats(...)
----

[discrete]
==== delete
Deletes an index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-delete-index.html[Endpoint documentation]
[source,ts]
----
client.indices.delete(...)
----

[discrete]
==== delete_alias
Deletes an alias.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-aliases.html[Endpoint documentation]
[source,ts]
----
client.indices.deleteAlias(...)
----

[discrete]
==== delete_data_stream
Deletes a data stream.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/data-streams.html[Endpoint documentation]
[source,ts]
----
client.indices.deleteDataStream(...)
----

[discrete]
==== delete_index_template
Deletes an index template.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-templates.html[Endpoint documentation]
[source,ts]
----
client.indices.deleteIndexTemplate(...)
----

[discrete]
==== delete_template
Deletes an index template.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-templates.html[Endpoint documentation]
[source,ts]
----
client.indices.deleteTemplate(...)
----

[discrete]
==== disk_usage
Analyzes the disk usage of each field of an index or data stream

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-disk-usage.html[Endpoint documentation]
[source,ts]
----
client.indices.diskUsage(...)
----

[discrete]
==== downsample
Downsample an index

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/xpack-rollup.html[Endpoint documentation]
[source,ts]
----
client.indices.downsample(...)
----

[discrete]
==== exists
Returns information about whether a particular index exists.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-exists.html[Endpoint documentation]
[source,ts]
----
client.indices.exists(...)
----

[discrete]
==== exists_alias
Returns information about whether a particular alias exists.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-aliases.html[Endpoint documentation]
[source,ts]
----
client.indices.existsAlias(...)
----

[discrete]
==== exists_index_template
Returns information about whether a particular index template exists.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-templates.html[Endpoint documentation]
[source,ts]
----
client.indices.existsIndexTemplate(...)
----

[discrete]
==== exists_template
Returns information about whether a particular index template exists.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-templates.html[Endpoint documentation]
[source,ts]
----
client.indices.existsTemplate(...)
----

[discrete]
==== field_usage_stats
Returns the field usage stats for each field of an index

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/field-usage-stats.html[Endpoint documentation]
[source,ts]
----
client.indices.fieldUsageStats(...)
----

[discrete]
==== flush
Performs the flush operation on one or more indices.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-flush.html[Endpoint documentation]
[source,ts]
----
client.indices.flush(...)
----

[discrete]
==== forcemerge
Performs the force merge operation on one or more indices.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-forcemerge.html[Endpoint documentation]
[source,ts]
----
client.indices.forcemerge(...)
----

[discrete]
==== get
Returns information about one or more indices.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-get-index.html[Endpoint documentation]
[source,ts]
----
client.indices.get(...)
----

[discrete]
==== get_alias
Returns an alias.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-aliases.html[Endpoint documentation]
[source,ts]
----
client.indices.getAlias(...)
----

[discrete]
==== get_data_stream
Returns data streams.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/data-streams.html[Endpoint documentation]
[source,ts]
----
client.indices.getDataStream(...)
----

[discrete]
==== get_field_mapping
Returns mapping for one or more fields.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-get-field-mapping.html[Endpoint documentation]
[source,ts]
----
client.indices.getFieldMapping(...)
----

[discrete]
==== get_index_template
Returns an index template.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-templates.html[Endpoint documentation]
[source,ts]
----
client.indices.getIndexTemplate(...)
----

[discrete]
==== get_mapping
Returns mappings for one or more indices.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-get-mapping.html[Endpoint documentation]
[source,ts]
----
client.indices.getMapping(...)
----

[discrete]
==== get_settings
Returns settings for one or more indices.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-get-settings.html[Endpoint documentation]
[source,ts]
----
client.indices.getSettings(...)
----

[discrete]
==== get_template
Returns an index template.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-templates.html[Endpoint documentation]
[source,ts]
----
client.indices.getTemplate(...)
----

[discrete]
==== migrate_to_data_stream
Migrates an alias to a data stream

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/data-streams.html[Endpoint documentation]
[source,ts]
----
client.indices.migrateToDataStream(...)
----

[discrete]
==== modify_data_stream
Modifies a data stream

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/data-streams.html[Endpoint documentation]
[source,ts]
----
client.indices.modifyDataStream(...)
----

[discrete]
==== open
Opens an index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-open-close.html[Endpoint documentation]
[source,ts]
----
client.indices.open(...)
----

[discrete]
==== promote_data_stream
Promotes a data stream from a replicated data stream managed by CCR to a regular data stream

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/data-streams.html[Endpoint documentation]
[source,ts]
----
client.indices.promoteDataStream(...)
----

[discrete]
==== put_alias
Creates or updates an alias.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-aliases.html[Endpoint documentation]
[source,ts]
----
client.indices.putAlias(...)
----

[discrete]
==== put_index_template
Creates or updates an index template.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-templates.html[Endpoint documentation]
[source,ts]
----
client.indices.putIndexTemplate(...)
----

[discrete]
==== put_mapping
Updates the index mappings.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-put-mapping.html[Endpoint documentation]
[source,ts]
----
client.indices.putMapping(...)
----

[discrete]
==== put_settings
Updates the index settings.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-update-settings.html[Endpoint documentation]
[source,ts]
----
client.indices.putSettings(...)
----

[discrete]
==== put_template
Creates or updates an index template.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-templates.html[Endpoint documentation]
[source,ts]
----
client.indices.putTemplate(...)
----

[discrete]
==== recovery
Returns information about ongoing index shard recoveries.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-recovery.html[Endpoint documentation]
[source,ts]
----
client.indices.recovery(...)
----

[discrete]
==== refresh
Performs the refresh operation in one or more indices.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-refresh.html[Endpoint documentation]
[source,ts]
----
client.indices.refresh(...)
----

[discrete]
==== reload_search_analyzers
Reloads an index's search analyzers and their resources.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-reload-analyzers.html[Endpoint documentation]
[source,ts]
----
client.indices.reloadSearchAnalyzers(...)
----

[discrete]
==== resolve_index
Returns information about any matching indices, aliases, and data streams

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-resolve-index-api.html[Endpoint documentation]
[source,ts]
----
client.indices.resolveIndex(...)
----

[discrete]
==== rollover
Updates an alias to point to a new index when the existing index
is considered to be too large or too old.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-rollover-index.html[Endpoint documentation]
[source,ts]
----
client.indices.rollover(...)
----

[discrete]
==== segments
Provides low-level information about segments in a Lucene index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-segments.html[Endpoint documentation]
[source,ts]
----
client.indices.segments(...)
----

[discrete]
==== shard_stores
Provides store information for shard copies of indices.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-shards-stores.html[Endpoint documentation]
[source,ts]
----
client.indices.shardStores(...)
----

[discrete]
==== shrink
Allow to shrink an existing index into a new index with fewer primary shards.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-shrink-index.html[Endpoint documentation]
[source,ts]
----
client.indices.shrink(...)
----

[discrete]
==== simulate_index_template
Simulate matching the given index name against the index templates in the system

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-templates.html[Endpoint documentation]
[source,ts]
----
client.indices.simulateIndexTemplate(...)
----

[discrete]
==== simulate_template
Simulate resolving the given template name or body

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-templates.html[Endpoint documentation]
[source,ts]
----
client.indices.simulateTemplate(...)
----

[discrete]
==== split
Allows you to split an existing index into a new index with more primary shards.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-split-index.html[Endpoint documentation]
[source,ts]
----
client.indices.split(...)
----

[discrete]
==== stats
Provides statistics on operations happening in an index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-stats.html[Endpoint documentation]
[source,ts]
----
client.indices.stats(...)
----

[discrete]
==== unfreeze
Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/unfreeze-index-api.html[Endpoint documentation]
[source,ts]
----
client.indices.unfreeze(...)
----

[discrete]
==== update_aliases
Updates index aliases.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-aliases.html[Endpoint documentation]
[source,ts]
----
client.indices.updateAliases(...)
----

[discrete]
==== validate_query
Allows a user to validate a potentially expensive query without executing it.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/search-validate.html[Endpoint documentation]
[source,ts]
----
client.indices.validateQuery(...)
----

[discrete]
=== ingest
[discrete]
==== delete_pipeline
Deletes a pipeline.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/delete-pipeline-api.html[Endpoint documentation]
[source,ts]
----
client.ingest.deletePipeline(...)
----

[discrete]
==== geo_ip_stats
Returns statistical information about geoip databases

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/geoip-stats-api.html[Endpoint documentation]
[source,ts]
----
client.ingest.geoIpStats(...)
----

[discrete]
==== get_pipeline
Returns a pipeline.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-pipeline-api.html[Endpoint documentation]
[source,ts]
----
client.ingest.getPipeline(...)
----

[discrete]
==== processor_grok
Returns a list of the built-in patterns.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/grok-processor.html#grok-processor-rest-get[Endpoint documentation]
[source,ts]
----
client.ingest.processorGrok(...)
----

[discrete]
==== put_pipeline
Creates or updates a pipeline.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/put-pipeline-api.html[Endpoint documentation]
[source,ts]
----
client.ingest.putPipeline(...)
----

[discrete]
==== simulate
Allows to simulate a pipeline with example documents.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/simulate-pipeline-api.html[Endpoint documentation]
[source,ts]
----
client.ingest.simulate(...)
----

[discrete]
=== license
[discrete]
==== delete
Deletes licensing information for the cluster

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/delete-license.html[Endpoint documentation]
[source,ts]
----
client.license.delete(...)
----

[discrete]
==== get
Retrieves licensing information for the cluster

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-license.html[Endpoint documentation]
[source,ts]
----
client.license.get(...)
----

[discrete]
==== get_basic_status
Retrieves information about the status of the basic license.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-basic-status.html[Endpoint documentation]
[source,ts]
----
client.license.getBasicStatus(...)
----

[discrete]
==== get_trial_status
Retrieves information about the status of the trial license.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-trial-status.html[Endpoint documentation]
[source,ts]
----
client.license.getTrialStatus(...)
----

[discrete]
==== post
Updates the license for the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/update-license.html[Endpoint documentation]
[source,ts]
----
client.license.post(...)
----

[discrete]
==== post_start_basic
Starts an indefinite basic license.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/start-basic.html[Endpoint documentation]
[source,ts]
----
client.license.postStartBasic(...)
----

[discrete]
==== post_start_trial
starts a limited time trial license.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/start-trial.html[Endpoint documentation]
[source,ts]
----
client.license.postStartTrial(...)
----

[discrete]
=== logstash
[discrete]
==== delete_pipeline
Deletes Logstash Pipelines used by Central Management

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/logstash-api-delete-pipeline.html[Endpoint documentation]
[source,ts]
----
client.logstash.deletePipeline(...)
----

[discrete]
==== get_pipeline
Retrieves Logstash Pipelines used by Central Management

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/logstash-api-get-pipeline.html[Endpoint documentation]
[source,ts]
----
client.logstash.getPipeline(...)
----

[discrete]
==== put_pipeline
Adds and updates Logstash Pipelines used for Central Management

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/logstash-api-put-pipeline.html[Endpoint documentation]
[source,ts]
----
client.logstash.putPipeline(...)
----

[discrete]
=== migration
[discrete]
==== deprecations
Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/migration-api-deprecation.html[Endpoint documentation]
[source,ts]
----
client.migration.deprecations(...)
----

[discrete]
==== get_feature_upgrade_status
Find out whether system features need to be upgraded or not

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/migration-api-feature-upgrade.html[Endpoint documentation]
[source,ts]
----
client.migration.getFeatureUpgradeStatus(...)
----

[discrete]
==== post_feature_upgrade
Begin upgrades for system features

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/migration-api-feature-upgrade.html[Endpoint documentation]
[source,ts]
----
client.migration.postFeatureUpgrade(...)
----

[discrete]
=== ml
[discrete]
==== clear_trained_model_deployment_cache
Clear the cached results from a trained model deployment

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/clear-trained-model-deployment-cache.html[Endpoint documentation]
[source,ts]
----
client.ml.clearTrainedModelDeploymentCache(...)
----

[discrete]
==== close_job
Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-close-job.html[Endpoint documentation]
[source,ts]
----
client.ml.closeJob(...)
----

[discrete]
==== delete_calendar
Deletes a calendar.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-delete-calendar.html[Endpoint documentation]
[source,ts]
----
client.ml.deleteCalendar(...)
----

[discrete]
==== delete_calendar_event
Deletes scheduled events from a calendar.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-delete-calendar-event.html[Endpoint documentation]
[source,ts]
----
client.ml.deleteCalendarEvent(...)
----

[discrete]
==== delete_calendar_job
Deletes anomaly detection jobs from a calendar.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-delete-calendar-job.html[Endpoint documentation]
[source,ts]
----
client.ml.deleteCalendarJob(...)
----

[discrete]
==== delete_data_frame_analytics
Deletes an existing data frame analytics job.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/delete-dfanalytics.html[Endpoint documentation]
[source,ts]
----
client.ml.deleteDataFrameAnalytics(...)
----

[discrete]
==== delete_datafeed
Deletes an existing datafeed.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-delete-datafeed.html[Endpoint documentation]
[source,ts]
----
client.ml.deleteDatafeed(...)
----

[discrete]
==== delete_expired_data
Deletes expired and unused machine learning data.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-delete-expired-data.html[Endpoint documentation]
[source,ts]
----
client.ml.deleteExpiredData(...)
----

[discrete]
==== delete_filter
Deletes a filter.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-delete-filter.html[Endpoint documentation]
[source,ts]
----
client.ml.deleteFilter(...)
----

[discrete]
==== delete_forecast
Deletes forecasts from a machine learning job.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-delete-forecast.html[Endpoint documentation]
[source,ts]
----
client.ml.deleteForecast(...)
----

[discrete]
==== delete_job
Deletes an existing anomaly detection job.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-delete-job.html[Endpoint documentation]
[source,ts]
----
client.ml.deleteJob(...)
----

[discrete]
==== delete_model_snapshot
Deletes an existing model snapshot.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-delete-snapshot.html[Endpoint documentation]
[source,ts]
----
client.ml.deleteModelSnapshot(...)
----

[discrete]
==== delete_trained_model
Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/delete-trained-models.html[Endpoint documentation]
[source,ts]
----
client.ml.deleteTrainedModel(...)
----

[discrete]
==== delete_trained_model_alias
Deletes a model alias that refers to the trained model

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/delete-trained-models-aliases.html[Endpoint documentation]
[source,ts]
----
client.ml.deleteTrainedModelAlias(...)
----

[discrete]
==== estimate_model_memory
Estimates the model memory

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-apis.html[Endpoint documentation]
[source,ts]
----
client.ml.estimateModelMemory(...)
----

[discrete]
==== evaluate_data_frame
Evaluates the data frame analytics for an annotated index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/evaluate-dfanalytics.html[Endpoint documentation]
[source,ts]
----
client.ml.evaluateDataFrame(...)
----

[discrete]
==== explain_data_frame_analytics
Explains a data frame analytics config.

http://www.elastic.co/guide/en/elasticsearch/reference/8.7/explain-dfanalytics.html[Endpoint documentation]
[source,ts]
----
client.ml.explainDataFrameAnalytics(...)
----

[discrete]
==== flush_job
Forces any buffered data to be processed by the job.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-flush-job.html[Endpoint documentation]
[source,ts]
----
client.ml.flushJob(...)
----

[discrete]
==== forecast
Predicts the future behavior of a time series by using its historical behavior.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-forecast.html[Endpoint documentation]
[source,ts]
----
client.ml.forecast(...)
----

[discrete]
==== get_buckets
Retrieves anomaly detection job results for one or more buckets.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-get-bucket.html[Endpoint documentation]
[source,ts]
----
client.ml.getBuckets(...)
----

[discrete]
==== get_calendar_events
Retrieves information about the scheduled events in calendars.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-get-calendar-event.html[Endpoint documentation]
[source,ts]
----
client.ml.getCalendarEvents(...)
----

[discrete]
==== get_calendars
Retrieves configuration information for calendars.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-get-calendar.html[Endpoint documentation]
[source,ts]
----
client.ml.getCalendars(...)
----

[discrete]
==== get_categories
Retrieves anomaly detection job results for one or more categories.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-get-category.html[Endpoint documentation]
[source,ts]
----
client.ml.getCategories(...)
----

[discrete]
==== get_data_frame_analytics
Retrieves configuration information for data frame analytics jobs.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-dfanalytics.html[Endpoint documentation]
[source,ts]
----
client.ml.getDataFrameAnalytics(...)
----

[discrete]
==== get_data_frame_analytics_stats
Retrieves usage information for data frame analytics jobs.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-dfanalytics-stats.html[Endpoint documentation]
[source,ts]
----
client.ml.getDataFrameAnalyticsStats(...)
----

[discrete]
==== get_datafeed_stats
Retrieves usage information for datafeeds.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-get-datafeed-stats.html[Endpoint documentation]
[source,ts]
----
client.ml.getDatafeedStats(...)
----

[discrete]
==== get_datafeeds
Retrieves configuration information for datafeeds.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-get-datafeed.html[Endpoint documentation]
[source,ts]
----
client.ml.getDatafeeds(...)
----

[discrete]
==== get_filters
Retrieves filters.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-get-filter.html[Endpoint documentation]
[source,ts]
----
client.ml.getFilters(...)
----

[discrete]
==== get_influencers
Retrieves anomaly detection job results for one or more influencers.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-get-influencer.html[Endpoint documentation]
[source,ts]
----
client.ml.getInfluencers(...)
----

[discrete]
==== get_job_stats
Retrieves usage information for anomaly detection jobs.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-get-job-stats.html[Endpoint documentation]
[source,ts]
----
client.ml.getJobStats(...)
----

[discrete]
==== get_jobs
Retrieves configuration information for anomaly detection jobs.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-get-job.html[Endpoint documentation]
[source,ts]
----
client.ml.getJobs(...)
----

[discrete]
==== get_memory_stats
Returns information on how ML is using memory.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-ml-memory.html[Endpoint documentation]
[source,ts]
----
client.ml.getMemoryStats(...)
----

[discrete]
==== get_model_snapshot_upgrade_stats
Gets stats for anomaly detection job model snapshot upgrades that are in progress.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-get-job-model-snapshot-upgrade-stats.html[Endpoint documentation]
[source,ts]
----
client.ml.getModelSnapshotUpgradeStats(...)
----

[discrete]
==== get_model_snapshots
Retrieves information about model snapshots.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-get-snapshot.html[Endpoint documentation]
[source,ts]
----
client.ml.getModelSnapshots(...)
----

[discrete]
==== get_overall_buckets
Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-get-overall-buckets.html[Endpoint documentation]
[source,ts]
----
client.ml.getOverallBuckets(...)
----

[discrete]
==== get_records
Retrieves anomaly records for an anomaly detection job.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-get-record.html[Endpoint documentation]
[source,ts]
----
client.ml.getRecords(...)
----

[discrete]
==== get_trained_models
Retrieves configuration information for a trained inference model.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-trained-models.html[Endpoint documentation]
[source,ts]
----
client.ml.getTrainedModels(...)
----

[discrete]
==== get_trained_models_stats
Retrieves usage information for trained inference models.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-trained-models-stats.html[Endpoint documentation]
[source,ts]
----
client.ml.getTrainedModelsStats(...)
----

[discrete]
==== infer_trained_model
Evaluate a trained model.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/infer-trained-model.html[Endpoint documentation]
[source,ts]
----
client.ml.inferTrainedModel(...)
----

[discrete]
==== info
Returns defaults and limits used by machine learning.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-ml-info.html[Endpoint documentation]
[source,ts]
----
client.ml.info(...)
----

[discrete]
==== open_job
Opens one or more anomaly detection jobs.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-open-job.html[Endpoint documentation]
[source,ts]
----
client.ml.openJob(...)
----

[discrete]
==== post_calendar_events
Posts scheduled events in a calendar.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-post-calendar-event.html[Endpoint documentation]
[source,ts]
----
client.ml.postCalendarEvents(...)
----

[discrete]
==== post_data
Sends data to an anomaly detection job for analysis.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-post-data.html[Endpoint documentation]
[source,ts]
----
client.ml.postData(...)
----

[discrete]
==== preview_data_frame_analytics
Previews that will be analyzed given a data frame analytics config.

http://www.elastic.co/guide/en/elasticsearch/reference/8.7/preview-dfanalytics.html[Endpoint documentation]
[source,ts]
----
client.ml.previewDataFrameAnalytics(...)
----

[discrete]
==== preview_datafeed
Previews a datafeed.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-preview-datafeed.html[Endpoint documentation]
[source,ts]
----
client.ml.previewDatafeed(...)
----

[discrete]
==== put_calendar
Instantiates a calendar.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-put-calendar.html[Endpoint documentation]
[source,ts]
----
client.ml.putCalendar(...)
----

[discrete]
==== put_calendar_job
Adds an anomaly detection job to a calendar.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-put-calendar-job.html[Endpoint documentation]
[source,ts]
----
client.ml.putCalendarJob(...)
----

[discrete]
==== put_data_frame_analytics
Instantiates a data frame analytics job.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/put-dfanalytics.html[Endpoint documentation]
[source,ts]
----
client.ml.putDataFrameAnalytics(...)
----

[discrete]
==== put_datafeed
Instantiates a datafeed.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-put-datafeed.html[Endpoint documentation]
[source,ts]
----
client.ml.putDatafeed(...)
----

[discrete]
==== put_filter
Instantiates a filter.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-put-filter.html[Endpoint documentation]
[source,ts]
----
client.ml.putFilter(...)
----

[discrete]
==== put_job
Instantiates an anomaly detection job.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-put-job.html[Endpoint documentation]
[source,ts]
----
client.ml.putJob(...)
----

[discrete]
==== put_trained_model
Creates an inference trained model.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/put-trained-models.html[Endpoint documentation]
[source,ts]
----
client.ml.putTrainedModel(...)
----

[discrete]
==== put_trained_model_alias
Creates a new model alias (or reassigns an existing one) to refer to the trained model

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/put-trained-models-aliases.html[Endpoint documentation]
[source,ts]
----
client.ml.putTrainedModelAlias(...)
----

[discrete]
==== put_trained_model_definition_part
Creates part of a trained model definition

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/put-trained-model-definition-part.html[Endpoint documentation]
[source,ts]
----
client.ml.putTrainedModelDefinitionPart(...)
----

[discrete]
==== put_trained_model_vocabulary
Creates a trained model vocabulary

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/put-trained-model-vocabulary.html[Endpoint documentation]
[source,ts]
----
client.ml.putTrainedModelVocabulary(...)
----

[discrete]
==== reset_job
Resets an existing anomaly detection job.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-reset-job.html[Endpoint documentation]
[source,ts]
----
client.ml.resetJob(...)
----

[discrete]
==== revert_model_snapshot
Reverts to a specific snapshot.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-revert-snapshot.html[Endpoint documentation]
[source,ts]
----
client.ml.revertModelSnapshot(...)
----

[discrete]
==== set_upgrade_mode
Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-set-upgrade-mode.html[Endpoint documentation]
[source,ts]
----
client.ml.setUpgradeMode(...)
----

[discrete]
==== start_data_frame_analytics
Starts a data frame analytics job.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/start-dfanalytics.html[Endpoint documentation]
[source,ts]
----
client.ml.startDataFrameAnalytics(...)
----

[discrete]
==== start_datafeed
Starts one or more datafeeds.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-start-datafeed.html[Endpoint documentation]
[source,ts]
----
client.ml.startDatafeed(...)
----

[discrete]
==== start_trained_model_deployment
Start a trained model deployment.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/start-trained-model-deployment.html[Endpoint documentation]
[source,ts]
----
client.ml.startTrainedModelDeployment(...)
----

[discrete]
==== stop_data_frame_analytics
Stops one or more data frame analytics jobs.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/stop-dfanalytics.html[Endpoint documentation]
[source,ts]
----
client.ml.stopDataFrameAnalytics(...)
----

[discrete]
==== stop_datafeed
Stops one or more datafeeds.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-stop-datafeed.html[Endpoint documentation]
[source,ts]
----
client.ml.stopDatafeed(...)
----

[discrete]
==== stop_trained_model_deployment
Stop a trained model deployment.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/stop-trained-model-deployment.html[Endpoint documentation]
[source,ts]
----
client.ml.stopTrainedModelDeployment(...)
----

[discrete]
==== update_data_frame_analytics
Updates certain properties of a data frame analytics job.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/update-dfanalytics.html[Endpoint documentation]
[source,ts]
----
client.ml.updateDataFrameAnalytics(...)
----

[discrete]
==== update_datafeed
Updates certain properties of a datafeed.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-update-datafeed.html[Endpoint documentation]
[source,ts]
----
client.ml.updateDatafeed(...)
----

[discrete]
==== update_filter
Updates the description of a filter, adds items, or removes items.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-update-filter.html[Endpoint documentation]
[source,ts]
----
client.ml.updateFilter(...)
----

[discrete]
==== update_job
Updates certain properties of an anomaly detection job.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-update-job.html[Endpoint documentation]
[source,ts]
----
client.ml.updateJob(...)
----

[discrete]
==== update_model_snapshot
Updates certain properties of a snapshot.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-update-snapshot.html[Endpoint documentation]
[source,ts]
----
client.ml.updateModelSnapshot(...)
----

[discrete]
==== update_trained_model_deployment
Updates certain properties of trained model deployment.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/update-trained-model-deployment.html[Endpoint documentation]
[source,ts]
----
client.ml.updateTrainedModelDeployment(...)
----

[discrete]
==== upgrade_job_snapshot
Upgrades a given job snapshot to the current major version.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/ml-upgrade-job-model-snapshot.html[Endpoint documentation]
[source,ts]
----
client.ml.upgradeJobSnapshot(...)
----

[discrete]
=== nodes
[discrete]
==== clear_repositories_metering_archive
Removes the archived repositories metering information present in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/clear-repositories-metering-archive-api.html[Endpoint documentation]
[source,ts]
----
client.nodes.clearRepositoriesMeteringArchive(...)
----

[discrete]
==== get_repositories_metering_info
Returns cluster repositories metering information.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-repositories-metering-api.html[Endpoint documentation]
[source,ts]
----
client.nodes.getRepositoriesMeteringInfo(...)
----

[discrete]
==== hot_threads
Returns information about hot threads on each node in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cluster-nodes-hot-threads.html[Endpoint documentation]
[source,ts]
----
client.nodes.hotThreads(...)
----

[discrete]
==== info
Returns information about nodes in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cluster-nodes-info.html[Endpoint documentation]
[source,ts]
----
client.nodes.info(...)
----

[discrete]
==== reload_secure_settings
Reloads secure settings.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/secure-settings.html#reloadable-secure-settings[Endpoint documentation]
[source,ts]
----
client.nodes.reloadSecureSettings(...)
----

[discrete]
==== stats
Returns statistical information about nodes in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cluster-nodes-stats.html[Endpoint documentation]
[source,ts]
----
client.nodes.stats(...)
----

[discrete]
==== usage
Returns low-level information about REST actions usage on nodes.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cluster-nodes-usage.html[Endpoint documentation]
[source,ts]
----
client.nodes.usage(...)
----

[discrete]
=== rollup
[discrete]
==== delete_job
Deletes an existing rollup job.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/rollup-delete-job.html[Endpoint documentation]
[source,ts]
----
client.rollup.deleteJob(...)
----

[discrete]
==== get_jobs
Retrieves the configuration, stats, and status of rollup jobs.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/rollup-get-job.html[Endpoint documentation]
[source,ts]
----
client.rollup.getJobs(...)
----

[discrete]
==== get_rollup_caps
Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/rollup-get-rollup-caps.html[Endpoint documentation]
[source,ts]
----
client.rollup.getRollupCaps(...)
----

[discrete]
==== get_rollup_index_caps
Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored).

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/rollup-get-rollup-index-caps.html[Endpoint documentation]
[source,ts]
----
client.rollup.getRollupIndexCaps(...)
----

[discrete]
==== put_job
Creates a rollup job.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/rollup-put-job.html[Endpoint documentation]
[source,ts]
----
client.rollup.putJob(...)
----

[discrete]
==== rollup_search
Enables searching rolled-up data using the standard query DSL.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/rollup-search.html[Endpoint documentation]
[source,ts]
----
client.rollup.rollupSearch(...)
----

[discrete]
==== start_job
Starts an existing, stopped rollup job.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/rollup-start-job.html[Endpoint documentation]
[source,ts]
----
client.rollup.startJob(...)
----

[discrete]
==== stop_job
Stops an existing, started rollup job.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/rollup-stop-job.html[Endpoint documentation]
[source,ts]
----
client.rollup.stopJob(...)
----

[discrete]
=== searchable_snapshots
[discrete]
==== cache_stats
Retrieve node-level cache statistics about searchable snapshots.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/searchable-snapshots-apis.html[Endpoint documentation]
[source,ts]
----
client.searchableSnapshots.cacheStats(...)
----

[discrete]
==== clear_cache
Clear the cache of searchable snapshots.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/searchable-snapshots-apis.html[Endpoint documentation]
[source,ts]
----
client.searchableSnapshots.clearCache(...)
----

[discrete]
==== mount
Mount a snapshot as a searchable index.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/searchable-snapshots-api-mount-snapshot.html[Endpoint documentation]
[source,ts]
----
client.searchableSnapshots.mount(...)
----

[discrete]
==== stats
Retrieve shard-level statistics about searchable snapshots.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/searchable-snapshots-apis.html[Endpoint documentation]
[source,ts]
----
client.searchableSnapshots.stats(...)
----

[discrete]
=== security
[discrete]
==== authenticate
Enables authentication as a user and retrieve information about the authenticated user.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-authenticate.html[Endpoint documentation]
[source,ts]
----
client.security.authenticate(...)
----

[discrete]
==== bulk_update_api_keys
Updates the attributes of multiple existing API keys.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-bulk-update-api-keys.html[Endpoint documentation]
[source,ts]
----
client.security.bulkUpdateApiKeys(...)
----

[discrete]
==== change_password
Changes the passwords of users in the native realm and built-in users.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-change-password.html[Endpoint documentation]
[source,ts]
----
client.security.changePassword(...)
----

[discrete]
==== clear_api_key_cache
Clear a subset or all entries from the API key cache.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-clear-api-key-cache.html[Endpoint documentation]
[source,ts]
----
client.security.clearApiKeyCache(...)
----

[discrete]
==== clear_cached_privileges
Evicts application privileges from the native application privileges cache.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-clear-privilege-cache.html[Endpoint documentation]
[source,ts]
----
client.security.clearCachedPrivileges(...)
----

[discrete]
==== clear_cached_realms
Evicts users from the user cache. Can completely clear the cache or evict specific users.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-clear-cache.html[Endpoint documentation]
[source,ts]
----
client.security.clearCachedRealms(...)
----

[discrete]
==== clear_cached_roles
Evicts roles from the native role cache.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-clear-role-cache.html[Endpoint documentation]
[source,ts]
----
client.security.clearCachedRoles(...)
----

[discrete]
==== clear_cached_service_tokens
Evicts tokens from the service account token caches.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-clear-service-token-caches.html[Endpoint documentation]
[source,ts]
----
client.security.clearCachedServiceTokens(...)
----

[discrete]
==== create_api_key
Creates an API key for access without requiring basic authentication.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-create-api-key.html[Endpoint documentation]
[source,ts]
----
client.security.createApiKey(...)
----

[discrete]
==== create_service_token
Creates a service account token for access without requiring basic authentication.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-create-service-token.html[Endpoint documentation]
[source,ts]
----
client.security.createServiceToken(...)
----

[discrete]
==== delete_privileges
Removes application privileges.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-delete-privilege.html[Endpoint documentation]
[source,ts]
----
client.security.deletePrivileges(...)
----

[discrete]
==== delete_role
Removes roles in the native realm.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-delete-role.html[Endpoint documentation]
[source,ts]
----
client.security.deleteRole(...)
----

[discrete]
==== delete_role_mapping
Removes role mappings.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-delete-role-mapping.html[Endpoint documentation]
[source,ts]
----
client.security.deleteRoleMapping(...)
----

[discrete]
==== delete_service_token
Deletes a service account token.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-delete-service-token.html[Endpoint documentation]
[source,ts]
----
client.security.deleteServiceToken(...)
----

[discrete]
==== delete_user
Deletes users from the native realm.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-delete-user.html[Endpoint documentation]
[source,ts]
----
client.security.deleteUser(...)
----

[discrete]
==== disable_user
Disables users in the native realm.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-disable-user.html[Endpoint documentation]
[source,ts]
----
client.security.disableUser(...)
----

[discrete]
==== enable_user
Enables users in the native realm.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-enable-user.html[Endpoint documentation]
[source,ts]
----
client.security.enableUser(...)
----

[discrete]
==== enroll_kibana
Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-kibana-enrollment.html[Endpoint documentation]
[source,ts]
----
client.security.enrollKibana(...)
----

[discrete]
==== enroll_node
Allows a new node to enroll to an existing cluster with security enabled.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-node-enrollment.html[Endpoint documentation]
[source,ts]
----
client.security.enrollNode(...)
----

[discrete]
==== get_api_key
Retrieves information for one or more API keys.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-get-api-key.html[Endpoint documentation]
[source,ts]
----
client.security.getApiKey(...)
----

[discrete]
==== get_builtin_privileges
Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-get-builtin-privileges.html[Endpoint documentation]
[source,ts]
----
client.security.getBuiltinPrivileges(...)
----

[discrete]
==== get_privileges
Retrieves application privileges.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-get-privileges.html[Endpoint documentation]
[source,ts]
----
client.security.getPrivileges(...)
----

[discrete]
==== get_role
Retrieves roles in the native realm.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-get-role.html[Endpoint documentation]
[source,ts]
----
client.security.getRole(...)
----

[discrete]
==== get_role_mapping
Retrieves role mappings.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-get-role-mapping.html[Endpoint documentation]
[source,ts]
----
client.security.getRoleMapping(...)
----

[discrete]
==== get_service_accounts
Retrieves information about service accounts.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-get-service-accounts.html[Endpoint documentation]
[source,ts]
----
client.security.getServiceAccounts(...)
----

[discrete]
==== get_service_credentials
Retrieves information of all service credentials for a service account.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-get-service-credentials.html[Endpoint documentation]
[source,ts]
----
client.security.getServiceCredentials(...)
----

[discrete]
==== get_token
Creates a bearer token for access without requiring basic authentication.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-get-token.html[Endpoint documentation]
[source,ts]
----
client.security.getToken(...)
----

[discrete]
==== get_user
Retrieves information about users in the native realm and built-in users.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-get-user.html[Endpoint documentation]
[source,ts]
----
client.security.getUser(...)
----

[discrete]
==== get_user_privileges
Retrieves security privileges for the logged in user.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-get-user-privileges.html[Endpoint documentation]
[source,ts]
----
client.security.getUserPrivileges(...)
----

[discrete]
==== grant_api_key
Creates an API key on behalf of another user.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-grant-api-key.html[Endpoint documentation]
[source,ts]
----
client.security.grantApiKey(...)
----

[discrete]
==== has_privileges
Determines whether the specified user has a specified list of privileges.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-has-privileges.html[Endpoint documentation]
[source,ts]
----
client.security.hasPrivileges(...)
----

[discrete]
==== invalidate_api_key
Invalidates one or more API keys.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-invalidate-api-key.html[Endpoint documentation]
[source,ts]
----
client.security.invalidateApiKey(...)
----

[discrete]
==== invalidate_token
Invalidates one or more access tokens or refresh tokens.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-invalidate-token.html[Endpoint documentation]
[source,ts]
----
client.security.invalidateToken(...)
----

[discrete]
==== oidc_authenticate
Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-oidc-authenticate.html[Endpoint documentation]
[source,ts]
----
client.security.oidcAuthenticate(...)
----

[discrete]
==== oidc_logout
Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-oidc-logout.html[Endpoint documentation]
[source,ts]
----
client.security.oidcLogout(...)
----

[discrete]
==== oidc_prepare_authentication
Creates an OAuth 2.0 authentication request as a URL string

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-oidc-prepare-authentication.html[Endpoint documentation]
[source,ts]
----
client.security.oidcPrepareAuthentication(...)
----

[discrete]
==== put_privileges
Adds or updates application privileges.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-put-privileges.html[Endpoint documentation]
[source,ts]
----
client.security.putPrivileges(...)
----

[discrete]
==== put_role
Adds and updates roles in the native realm.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-put-role.html[Endpoint documentation]
[source,ts]
----
client.security.putRole(...)
----

[discrete]
==== put_role_mapping
Creates and updates role mappings.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-put-role-mapping.html[Endpoint documentation]
[source,ts]
----
client.security.putRoleMapping(...)
----

[discrete]
==== put_user
Adds and updates users in the native realm. These users are commonly referred to as native users.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-put-user.html[Endpoint documentation]
[source,ts]
----
client.security.putUser(...)
----

[discrete]
==== query_api_keys
Retrieves information for API keys using a subset of query DSL

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-query-api-key.html[Endpoint documentation]
[source,ts]
----
client.security.queryApiKeys(...)
----

[discrete]
==== saml_authenticate
Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-saml-authenticate.html[Endpoint documentation]
[source,ts]
----
client.security.samlAuthenticate(...)
----

[discrete]
==== saml_complete_logout
Verifies the logout response sent from the SAML IdP

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-saml-complete-logout.html[Endpoint documentation]
[source,ts]
----
client.security.samlCompleteLogout(...)
----

[discrete]
==== saml_invalidate
Consumes a SAML LogoutRequest

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-saml-invalidate.html[Endpoint documentation]
[source,ts]
----
client.security.samlInvalidate(...)
----

[discrete]
==== saml_logout
Invalidates an access token and a refresh token that were generated via the SAML Authenticate API

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-saml-logout.html[Endpoint documentation]
[source,ts]
----
client.security.samlLogout(...)
----

[discrete]
==== saml_prepare_authentication
Creates a SAML authentication request

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-saml-prepare-authentication.html[Endpoint documentation]
[source,ts]
----
client.security.samlPrepareAuthentication(...)
----

[discrete]
==== saml_service_provider_metadata
Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-saml-sp-metadata.html[Endpoint documentation]
[source,ts]
----
client.security.samlServiceProviderMetadata(...)
----

[discrete]
==== update_api_key
Updates attributes of an existing API key.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-update-api-key.html[Endpoint documentation]
[source,ts]
----
client.security.updateApiKey(...)
----

[discrete]
=== slm
[discrete]
==== delete_lifecycle
Deletes an existing snapshot lifecycle policy.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/slm-api-delete-policy.html[Endpoint documentation]
[source,ts]
----
client.slm.deleteLifecycle(...)
----

[discrete]
==== execute_lifecycle
Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/slm-api-execute-lifecycle.html[Endpoint documentation]
[source,ts]
----
client.slm.executeLifecycle(...)
----

[discrete]
==== execute_retention
Deletes any snapshots that are expired according to the policy's retention rules.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/slm-api-execute-retention.html[Endpoint documentation]
[source,ts]
----
client.slm.executeRetention(...)
----

[discrete]
==== get_lifecycle
Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/slm-api-get-policy.html[Endpoint documentation]
[source,ts]
----
client.slm.getLifecycle(...)
----

[discrete]
==== get_stats
Returns global and policy-level statistics about actions taken by snapshot lifecycle management.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/slm-api-get-stats.html[Endpoint documentation]
[source,ts]
----
client.slm.getStats(...)
----

[discrete]
==== get_status
Retrieves the status of snapshot lifecycle management (SLM).

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/slm-api-get-status.html[Endpoint documentation]
[source,ts]
----
client.slm.getStatus(...)
----

[discrete]
==== put_lifecycle
Creates or updates a snapshot lifecycle policy.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/slm-api-put-policy.html[Endpoint documentation]
[source,ts]
----
client.slm.putLifecycle(...)
----

[discrete]
==== start
Turns on snapshot lifecycle management (SLM).

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/slm-api-start.html[Endpoint documentation]
[source,ts]
----
client.slm.start(...)
----

[discrete]
==== stop
Turns off snapshot lifecycle management (SLM).

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/slm-api-stop.html[Endpoint documentation]
[source,ts]
----
client.slm.stop(...)
----

[discrete]
=== snapshot
[discrete]
==== cleanup_repository
Removes stale data from repository.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/clean-up-snapshot-repo-api.html[Endpoint documentation]
[source,ts]
----
client.snapshot.cleanupRepository(...)
----

[discrete]
==== clone
Clones indices from one snapshot into another snapshot in the same repository.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-snapshots.html[Endpoint documentation]
[source,ts]
----
client.snapshot.clone(...)
----

[discrete]
==== create
Creates a snapshot in a repository.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-snapshots.html[Endpoint documentation]
[source,ts]
----
client.snapshot.create(...)
----

[discrete]
==== create_repository
Creates a repository.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-snapshots.html[Endpoint documentation]
[source,ts]
----
client.snapshot.createRepository(...)
----

[discrete]
==== delete
Deletes one or more snapshots.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-snapshots.html[Endpoint documentation]
[source,ts]
----
client.snapshot.delete(...)
----

[discrete]
==== delete_repository
Deletes a repository.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-snapshots.html[Endpoint documentation]
[source,ts]
----
client.snapshot.deleteRepository(...)
----

[discrete]
==== get
Returns information about a snapshot.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-snapshots.html[Endpoint documentation]
[source,ts]
----
client.snapshot.get(...)
----

[discrete]
==== get_repository
Returns information about a repository.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-snapshots.html[Endpoint documentation]
[source,ts]
----
client.snapshot.getRepository(...)
----

[discrete]
==== repository_analyze
Analyzes a repository for correctness and performance

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-snapshots.html[Endpoint documentation]
[source,ts]
----
client.snapshot.repositoryAnalyze(...)
----

[discrete]
==== restore
Restores a snapshot.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-snapshots.html[Endpoint documentation]
[source,ts]
----
client.snapshot.restore(...)
----

[discrete]
==== status
Returns information about the status of a snapshot.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-snapshots.html[Endpoint documentation]
[source,ts]
----
client.snapshot.status(...)
----

[discrete]
==== verify_repository
Verifies a repository.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/modules-snapshots.html[Endpoint documentation]
[source,ts]
----
client.snapshot.verifyRepository(...)
----

[discrete]
=== sql
[discrete]
==== clear_cursor
Clears the SQL cursor

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/clear-sql-cursor-api.html[Endpoint documentation]
[source,ts]
----
client.sql.clearCursor(...)
----

[discrete]
==== delete_async
Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/delete-async-sql-search-api.html[Endpoint documentation]
[source,ts]
----
client.sql.deleteAsync(...)
----

[discrete]
==== get_async
Returns the current status and available results for an async SQL search or stored synchronous SQL search

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-async-sql-search-api.html[Endpoint documentation]
[source,ts]
----
client.sql.getAsync(...)
----

[discrete]
==== get_async_status
Returns the current status of an async SQL search or a stored synchronous SQL search

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-async-sql-search-status-api.html[Endpoint documentation]
[source,ts]
----
client.sql.getAsyncStatus(...)
----

[discrete]
==== query
Executes a SQL request

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/sql-search-api.html[Endpoint documentation]
[source,ts]
----
client.sql.query(...)
----

[discrete]
==== translate
Translates SQL into Elasticsearch queries

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/sql-translate-api.html[Endpoint documentation]
[source,ts]
----
client.sql.translate(...)
----

[discrete]
=== ssl
[discrete]
==== certificates
Retrieves information about the X.509 certificates used to encrypt communications in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/security-api-ssl.html[Endpoint documentation]
[source,ts]
----
client.ssl.certificates(...)
----

[discrete]
=== tasks
[discrete]
==== cancel
Cancels a task, if it can be cancelled through an API.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/tasks.html[Endpoint documentation]
[source,ts]
----
client.tasks.cancel(...)
----

[discrete]
==== get
Returns information about a task.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/tasks.html[Endpoint documentation]
[source,ts]
----
client.tasks.get(...)
----

[discrete]
==== list
Returns a list of tasks.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/tasks.html[Endpoint documentation]
[source,ts]
----
client.tasks.list(...)
----

[discrete]
=== text_structure
[discrete]
==== find_structure
Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/find-structure.html[Endpoint documentation]
[source,ts]
----
client.textStructure.findStructure(...)
----

[discrete]
=== transform
[discrete]
==== delete_transform
Deletes an existing transform.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/delete-transform.html[Endpoint documentation]
[source,ts]
----
client.transform.deleteTransform(...)
----

[discrete]
==== get_transform
Retrieves configuration information for transforms.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-transform.html[Endpoint documentation]
[source,ts]
----
client.transform.getTransform(...)
----

[discrete]
==== get_transform_stats
Retrieves usage information for transforms.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/get-transform-stats.html[Endpoint documentation]
[source,ts]
----
client.transform.getTransformStats(...)
----

[discrete]
==== preview_transform
Previews a transform.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/preview-transform.html[Endpoint documentation]
[source,ts]
----
client.transform.previewTransform(...)
----

[discrete]
==== put_transform
Instantiates a transform.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/put-transform.html[Endpoint documentation]
[source,ts]
----
client.transform.putTransform(...)
----

[discrete]
==== reset_transform
Resets an existing transform.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/reset-transform.html[Endpoint documentation]
[source,ts]
----
client.transform.resetTransform(...)
----

[discrete]
==== schedule_now_transform
Schedules now a transform.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/schedule-now-transform.html[Endpoint documentation]
[source,ts]
----
client.transform.scheduleNowTransform(...)
----

[discrete]
==== start_transform
Starts one or more transforms.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/start-transform.html[Endpoint documentation]
[source,ts]
----
client.transform.startTransform(...)
----

[discrete]
==== stop_transform
Stops one or more transforms.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/stop-transform.html[Endpoint documentation]
[source,ts]
----
client.transform.stopTransform(...)
----

[discrete]
==== update_transform
Updates certain properties of a transform.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/update-transform.html[Endpoint documentation]
[source,ts]
----
client.transform.updateTransform(...)
----

[discrete]
==== upgrade_transforms
Upgrades all transforms.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/upgrade-transforms.html[Endpoint documentation]
[source,ts]
----
client.transform.upgradeTransforms(...)
----

[discrete]
=== watcher
[discrete]
==== ack_watch
Acknowledges a watch, manually throttling the execution of the watch's actions.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/watcher-api-ack-watch.html[Endpoint documentation]
[source,ts]
----
client.watcher.ackWatch(...)
----

[discrete]
==== activate_watch
Activates a currently inactive watch.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/watcher-api-activate-watch.html[Endpoint documentation]
[source,ts]
----
client.watcher.activateWatch(...)
----

[discrete]
==== deactivate_watch
Deactivates a currently active watch.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/watcher-api-deactivate-watch.html[Endpoint documentation]
[source,ts]
----
client.watcher.deactivateWatch(...)
----

[discrete]
==== delete_watch
Removes a watch from Watcher.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/watcher-api-delete-watch.html[Endpoint documentation]
[source,ts]
----
client.watcher.deleteWatch(...)
----

[discrete]
==== execute_watch
Forces the execution of a stored watch.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/watcher-api-execute-watch.html[Endpoint documentation]
[source,ts]
----
client.watcher.executeWatch(...)
----

[discrete]
==== get_watch
Retrieves a watch by its ID.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/watcher-api-get-watch.html[Endpoint documentation]
[source,ts]
----
client.watcher.getWatch(...)
----

[discrete]
==== put_watch
Creates a new watch, or updates an existing one.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/watcher-api-put-watch.html[Endpoint documentation]
[source,ts]
----
client.watcher.putWatch(...)
----

[discrete]
==== query_watches
Retrieves stored watches.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/watcher-api-query-watches.html[Endpoint documentation]
[source,ts]
----
client.watcher.queryWatches(...)
----

[discrete]
==== start
Starts Watcher if it is not already running.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/watcher-api-start.html[Endpoint documentation]
[source,ts]
----
client.watcher.start(...)
----

[discrete]
==== stats
Retrieves the current Watcher metrics.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/watcher-api-stats.html[Endpoint documentation]
[source,ts]
----
client.watcher.stats(...)
----

[discrete]
==== stop
Stops Watcher if it is running.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/watcher-api-stop.html[Endpoint documentation]
[source,ts]
----
client.watcher.stop(...)
----

[discrete]
=== xpack
[discrete]
==== info
Retrieves information about the installed X-Pack features.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/info-api.html[Endpoint documentation]
[source,ts]
----
client.xpack.info(...)
----

[discrete]
==== usage
Retrieves usage information about the installed X-Pack features.

https://www.elastic.co/guide/en/elasticsearch/reference/8.7/usage-api.html[Endpoint documentation]
[source,ts]
----
client.xpack.usage(...)
----