habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[api] regenerate

Browse Source
This commit is contained in:
spalger
2016-10-26 19:26:14 -07:00
parent a345d714f2
commit d369e3ba9e
5 changed files with 584 additions and 584 deletions
Download Patch File Download Diff File Expand all files Collapse all files

238
docs/api_methods.asciidoc
View File

@ -15,7 +15,7 @@ client.bulk([params, [callback]])
Perform many index/delete operations in a single API call.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html[the elasticsearch docs] for more about this method.
.Perform three operations in a single request
[source,js]
@ -84,7 +84,7 @@ client.clearScroll([params, [callback]])
Clear the scroll request created by specifying the scroll parameter to search.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html[the elasticsearch docs] for more about this method.
// no examples
@ -107,7 +107,7 @@ client.count([params, [callback]])
Get the number of documents for the cluster, index, type, or a query.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.html[the elasticsearch docs] for more about this method.
.Get the number of all documents in the cluster
[source,js]
@ -207,7 +207,7 @@ client.countPercolate([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more about this method.
// no examples
@ -264,7 +264,7 @@ client.create([params, [callback]])
Adds a typed JSON document in a specific index, making it searchable. If a document with the same `index`, `type`, and `id` already exists, an error will occur.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for more about this method.
.Create a document
[source,js]
@ -340,7 +340,7 @@ client.delete([params, [callback]])
Delete a typed JSON document from a specific index based on its id.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.html[the elasticsearch docs] for more about this method.
.Delete the document `/myindex/mytype/1`
[source,js]
@ -403,7 +403,7 @@ client.deleteByQuery([params, [callback]])
Delete documents from one or more indices and one or more types based on a query.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html[the elasticsearch docs] for more about this method.
.Deleting documents with a simple query
[source,js]
@ -555,7 +555,7 @@ client.deleteScript([params, [callback]])
// no description
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more about this method.
// no examples
@ -580,7 +580,7 @@ client.deleteTemplate([params, [callback]])
// no description
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -603,7 +603,7 @@ client.exists([params, [callback]])
Returns a boolean indicating whether or not a given document exists.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more about this method.
.Check that the document `/myindex/mytype/1` exist
[source,js]
@ -654,7 +654,7 @@ client.explain([params, [callback]])
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.html[the elasticsearch docs] for more about this method.
.See how a document is scored against a simple query
[source,js]
@ -744,7 +744,7 @@ client.fieldStats([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -787,7 +787,7 @@ client.get([params, [callback]])
Get a typed JSON document from the index based on its id.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more about this method.
.Get `/myindex/mytype/1`
[source,js]
@ -852,7 +852,7 @@ client.getScript([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more about this method.
// no examples
@ -878,7 +878,7 @@ client.getSource([params, [callback]])
Get the source of a document by its index, type and id.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more about this method.
// no examples
@ -931,7 +931,7 @@ client.getTemplate([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -959,7 +959,7 @@ Optimistic concurrency control is performed, when the `version` argument is spec
By default, the document will be available for `get()` actions immediately, but will only be available for searching after an index refresh (which can happen automatically or manually). See <<api-indices-refresh>>.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for more about this method.
.Create or update a document
[source,js]
@ -1039,7 +1039,7 @@ client.info([params, [callback]])
Get basic info from the current cluster.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/[the elasticsearch docs] for more about this method.
// no examples
@ -1055,7 +1055,7 @@ client.mget([params, [callback]])
Get multiple documents based on an index, type (optional) and ids. The body required by mget can take two forms: an array of document locations, or an array of document ids.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html[the elasticsearch docs] for more about this method.
.An array of doc locations. Useful for getting documents from different indices.
[source,js]
@ -1122,7 +1122,7 @@ client.mpercolate([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more about this method.
// no examples
@ -1159,7 +1159,7 @@ client.msearch([params, [callback]])
Execute several search requests within the same request.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html[the elasticsearch docs] for more about this method.
.Perform multiple different searches, the body is made up of meta/data pairs
[source,js]
@ -1209,7 +1209,7 @@ client.msearchTemplate([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -1242,7 +1242,7 @@ client.mtermvectors([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.html[the elasticsearch docs] for more about this method.
// no examples
@ -1299,7 +1299,7 @@ client.percolate([params, [callback]])
Match a document against registered percolator queries.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more about this method.
.First, Register queries named “alert-1” and “alert-2” for the “myindex” index
[source,js]
@ -1438,7 +1438,7 @@ client.ping([params, [callback]])
// no description
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/[the elasticsearch docs] for more about this method.
// no examples
@ -1454,7 +1454,7 @@ client.putScript([params, [callback]])
// no description
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more about this method.
// no examples
@ -1479,7 +1479,7 @@ client.putTemplate([params, [callback]])
// no description
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -1502,7 +1502,7 @@ client.reindex([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for more about this method.
// no examples
@ -1533,7 +1533,7 @@ client.reindexRethrottle([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for more about this method.
// no examples
@ -1558,7 +1558,7 @@ client.renderSearchTemplate([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -1581,7 +1581,7 @@ client.scroll([params, [callback]])
Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html[the elasticsearch docs] for more about this method.
.Collect every title in the index that contains the word "test"
[source,js]
@ -1640,7 +1640,7 @@ TIP: https://github.com/fullscale/elastic.js[elastic.js], https://github.com/hol
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.html[the elasticsearch docs] for more about this method.
.Search with a simple query string query
[source,js]
@ -1785,7 +1785,7 @@ client.searchShards([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.html[the elasticsearch docs] for more about this method.
// no examples
@ -1828,7 +1828,7 @@ client.searchTemplate([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -1879,7 +1879,7 @@ client.suggest([params, [callback]])
The suggest feature suggests similar looking terms based on a provided text by using a specific suggester.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-suggesters.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html[the elasticsearch docs] for more about this method.
.Return query terms suggestions (“auto-correction”)
[source,js]
@ -1951,7 +1951,7 @@ client.termvectors([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.html[the elasticsearch docs] for more about this method.
// no examples
@ -2011,7 +2011,7 @@ Update parts of a document. The required body parameter can contain one of two t
* a partial document, which will be merged with the existing one.
* a `script` which will update the document content
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.html[the elasticsearch docs] for more about this method.
.Update document title using partial document
[source,js]
@ -2146,7 +2146,7 @@ client.updateByQuery([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.html[the elasticsearch docs] for more about this method.
// no examples
@ -2315,7 +2315,7 @@ client.cat.allocation([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-allocation.html[the elasticsearch docs] for more about this method.
// no examples
@ -2365,7 +2365,7 @@ client.cat.count([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-count.html[the elasticsearch docs] for more about this method.
// no examples
@ -2400,7 +2400,7 @@ client.cat.fielddata([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-fielddata.html[the elasticsearch docs] for more about this method.
// no examples
@ -2450,7 +2450,7 @@ client.cat.health([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-health.html[the elasticsearch docs] for more about this method.
// no examples
@ -2485,7 +2485,7 @@ client.cat.help([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat.html[the elasticsearch docs] for more about this method.
// no examples
@ -2508,7 +2508,7 @@ client.cat.indices([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-indices.html[the elasticsearch docs] for more about this method.
// no examples
@ -2560,7 +2560,7 @@ client.cat.master([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-master.html[the elasticsearch docs] for more about this method.
// no examples
@ -2593,7 +2593,7 @@ client.cat.nodeattrs([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodeattrs.html[the elasticsearch docs] for more about this method.
// no examples
@ -2626,7 +2626,7 @@ client.cat.nodes([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodes.html[the elasticsearch docs] for more about this method.
// no examples
@ -2659,7 +2659,7 @@ client.cat.pendingTasks([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-pending-tasks.html[the elasticsearch docs] for more about this method.
// no examples
@ -2692,7 +2692,7 @@ client.cat.plugins([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-plugins.html[the elasticsearch docs] for more about this method.
// no examples
@ -2725,7 +2725,7 @@ client.cat.recovery([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-recovery.html[the elasticsearch docs] for more about this method.
// no examples
@ -2773,7 +2773,7 @@ client.cat.repositories([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-repositories.html[the elasticsearch docs] for more about this method.
// no examples
@ -2806,7 +2806,7 @@ client.cat.segments([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-segments.html[the elasticsearch docs] for more about this method.
// no examples
@ -2837,7 +2837,7 @@ client.cat.shards([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-shards.html[the elasticsearch docs] for more about this method.
// no examples
@ -2872,7 +2872,7 @@ client.cat.snapshots([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -2907,7 +2907,7 @@ client.cat.tasks([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more about this method.
// no examples
@ -2946,7 +2946,7 @@ client.cat.threadPool([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-thread-pool.html[the elasticsearch docs] for more about this method.
// no examples
@ -2991,7 +2991,7 @@ client.cluster.allocationExplain([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.html[the elasticsearch docs] for more about this method.
// no examples
@ -3016,7 +3016,7 @@ client.cluster.getSettings([params, [callback]])
Get cluster settings (previously set with `putSettings()`)
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -3045,7 +3045,7 @@ client.cluster.health([params, [callback]])
Get a very simple status on the health of the cluster.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-health.html[the elasticsearch docs] for more about this method.
// no examples
@ -3104,7 +3104,7 @@ client.cluster.pendingTasks([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-pending.html[the elasticsearch docs] for more about this method.
// no examples
@ -3129,7 +3129,7 @@ client.cluster.putSettings([params, [callback]])
Update cluster wide specific settings.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -3156,7 +3156,7 @@ client.cluster.reroute([params, [callback]])
Explicitly execute a cluster reroute allocation command including specific commands.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.html[the elasticsearch docs] for more about this method.
// no examples
@ -3189,7 +3189,7 @@ client.cluster.state([params, [callback]])
Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc).
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-state.html[the elasticsearch docs] for more about this method.
// no examples
@ -3232,7 +3232,7 @@ client.cluster.stats([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -3261,7 +3261,7 @@ client.indices.analyze([params, [callback]])
Perform the analysis process on a text and return the tokens breakdown of the text.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-analyze.html[the elasticsearch docs] for more about this method.
// no examples
@ -3308,7 +3308,7 @@ client.indices.clearCache([params, [callback]])
Clear either all caches or specific cached associated with one ore more indices.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-clearcache.html[the elasticsearch docs] for more about this method.
// no examples
@ -3356,7 +3356,7 @@ client.indices.close([params, [callback]])
Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html[the elasticsearch docs] for more about this method.
// no examples
@ -3395,7 +3395,7 @@ client.indices.create([params, [callback]])
Create an index in Elasticsearch.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-create-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -3426,7 +3426,7 @@ client.indices.delete([params, [callback]])
Delete an index in Elasticsearch
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -3453,7 +3453,7 @@ client.indices.deleteAlias([params, [callback]])
Delete a specific alias.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3482,7 +3482,7 @@ client.indices.deleteTemplate([params, [callback]])
Delete an index template by its name.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -3509,7 +3509,7 @@ client.indices.exists([params, [callback]])
Return a boolean indicating whether given index exists.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html[the elasticsearch docs] for more about this method.
// no examples
@ -3546,7 +3546,7 @@ client.indices.existsAlias([params, [callback]])
Return a boolean indicating whether given alias exists.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3585,7 +3585,7 @@ client.indices.existsTemplate([params, [callback]])
// no description
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -3612,7 +3612,7 @@ client.indices.existsType([params, [callback]])
Check if a type/types exists in an index/indices.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-types-exists.html[the elasticsearch docs] for more about this method.
// no examples
@ -3651,7 +3651,7 @@ client.indices.flush([params, [callback]])
Explicitly flush one or more indices.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-flush.html[the elasticsearch docs] for more about this method.
// no examples
@ -3690,7 +3690,7 @@ client.indices.flushSynced([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-synced-flush.html[the elasticsearch docs] for more about this method.
// no examples
@ -3725,7 +3725,7 @@ client.indices.forcemerge([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.html[the elasticsearch docs] for more about this method.
// no examples
@ -3770,7 +3770,7 @@ client.indices.get([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -3815,7 +3815,7 @@ client.indices.getAlias([params, [callback]])
Retrieve a specified alias.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3854,7 +3854,7 @@ client.indices.getFieldMapping([params, [callback]])
Retrieve mapping definition of a specific field.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-field-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -3897,7 +3897,7 @@ client.indices.getMapping([params, [callback]])
Retrieve mapping definition of index or index/type.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -3936,7 +3936,7 @@ client.indices.getSettings([params, [callback]])
Retrieve settings for one or more (or all) indices.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -3981,7 +3981,7 @@ client.indices.getTemplate([params, [callback]])
Retrieve an index template by its name.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -4010,7 +4010,7 @@ client.indices.getUpgrade([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html[the elasticsearch docs] for more about this method.
// no examples
@ -4047,7 +4047,7 @@ client.indices.open([params, [callback]])
Open a closed index, making it available for search.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html[the elasticsearch docs] for more about this method.
// no examples
@ -4086,7 +4086,7 @@ client.indices.putAlias([params, [callback]])
Create an alias for a specific index/indices.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -4115,7 +4115,7 @@ client.indices.putMapping([params, [callback]])
Register specific mapping definition for a specific type.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -4158,7 +4158,7 @@ client.indices.putSettings([params, [callback]])
Change specific index level settings in real time.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -4199,7 +4199,7 @@ client.indices.putTemplate([params, [callback]])
Create an index template that will automatically be applied to new indices created.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -4232,7 +4232,7 @@ client.indices.recovery([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-recovery.html[the elasticsearch docs] for more about this method.
// no examples
@ -4261,7 +4261,7 @@ client.indices.refresh([params, [callback]])
Explicitly refresh one or more index, making all operations performed since the last refresh available for search.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.html[the elasticsearch docs] for more about this method.
// no examples
@ -4300,7 +4300,7 @@ client.indices.rollover([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-rollover-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -4331,7 +4331,7 @@ client.indices.segments([params, [callback]])
Retrieve low level segments information that a Lucene index (shard level) is built with.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-segments.html[the elasticsearch docs] for more about this method.
// no examples
@ -4372,7 +4372,7 @@ client.indices.shardStores([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shards-stores.html[the elasticsearch docs] for more about this method.
// no examples
@ -4411,7 +4411,7 @@ client.indices.shrink([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shrink-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -4442,7 +4442,7 @@ client.indices.stats([params, [callback]])
Retrieve statistics on different operations happening on an index.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -4486,7 +4486,7 @@ client.indices.updateAliases([params, [callback]])
Update specified aliases.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more about this method.
.Perform an atomic alias swap, for a rotating index
[source,js]
@ -4524,7 +4524,7 @@ client.indices.upgrade([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html[the elasticsearch docs] for more about this method.
// no examples
@ -4561,7 +4561,7 @@ client.indices.validateQuery([params, [callback]])
Validate a potentially expensive query without executing it.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.html[the elasticsearch docs] for more about this method.
// no examples
@ -4622,7 +4622,7 @@ client.ingest.deletePipeline([params, [callback]])
// no description
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more about this method.
// no examples
@ -4649,7 +4649,7 @@ client.ingest.getPipeline([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more about this method.
// no examples
@ -4674,7 +4674,7 @@ client.ingest.putPipeline([params, [callback]])
// no description
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more about this method.
// no examples
@ -4701,7 +4701,7 @@ client.ingest.simulate([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more about this method.
// no examples
@ -4726,7 +4726,7 @@ client.nodes.hotThreads([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-hot-threads.html[the elasticsearch docs] for more about this method.
// no examples
@ -4766,7 +4766,7 @@ client.nodes.info([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-info.html[the elasticsearch docs] for more about this method.
// no examples
@ -4797,7 +4797,7 @@ client.nodes.stats([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -4845,7 +4845,7 @@ client.snapshot.create([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4874,7 +4874,7 @@ client.snapshot.createRepository([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4903,7 +4903,7 @@ client.snapshot.delete([params, [callback]])
// no description
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4930,7 +4930,7 @@ client.snapshot.deleteRepository([params, [callback]])
// no description
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4957,7 +4957,7 @@ client.snapshot.get([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4986,7 +4986,7 @@ client.snapshot.getRepository([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -5013,7 +5013,7 @@ client.snapshot.restore([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -5042,7 +5042,7 @@ client.snapshot.status([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -5071,7 +5071,7 @@ client.snapshot.verifyRepository([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -5098,7 +5098,7 @@ client.tasks.cancel([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more about this method.
// no examples
@ -5129,7 +5129,7 @@ client.tasks.get([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more about this method.
// no examples
@ -5154,7 +5154,7 @@ client.tasks.list([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more about this method.
// no examples

226
docs/api_methods_2_4.asciidoc
View File

@ -15,7 +15,7 @@ client.bulk([params, [callback]])
Perform many index/delete operations in a single API call.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-bulk.html[the elasticsearch docs] for more about this method.
.Perform three operations in a single request
[source,js]
@ -75,7 +75,7 @@ client.clearScroll([params, [callback]])
Clear the scroll request created by specifying the scroll parameter to search.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-request-scroll.html[the elasticsearch docs] for more about this method.
// no examples
@ -98,7 +98,7 @@ client.count([params, [callback]])
Get the number of documents for the cluster, index, type, or a query.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-count.html[the elasticsearch docs] for more about this method.
.Get the number of all documents in the cluster
[source,js]
@ -198,7 +198,7 @@ client.countPercolate([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-percolate.html[the elasticsearch docs] for more about this method.
// no examples
@ -255,7 +255,7 @@ client.create([params, [callback]])
Adds a typed JSON document in a specific index, making it searchable. If a document with the same `index`, `type`, and `id` already exists, an error will occur.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-index_.html[the elasticsearch docs] for more about this method.
.Create a document
[source,js]
@ -328,7 +328,7 @@ client.delete([params, [callback]])
Delete a typed JSON document from a specific index based on its id.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-delete.html[the elasticsearch docs] for more about this method.
.Delete the document `/myindex/mytype/1`
[source,js]
@ -390,7 +390,7 @@ client.deleteScript([params, [callback]])
// no description
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-scripting.html[the elasticsearch docs] for more about this method.
// no examples
@ -425,7 +425,7 @@ client.deleteTemplate([params, [callback]])
// no description
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -458,7 +458,7 @@ client.exists([params, [callback]])
Returns a boolean indicating whether or not a given document exists.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-get.html[the elasticsearch docs] for more about this method.
.Check that the document `/myindex/mytype/1` exist
[source,js]
@ -509,7 +509,7 @@ client.explain([params, [callback]])
Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters].
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-explain.html[the elasticsearch docs] for more about this method.
.See how a document is scored against a simple query
[source,js]
@ -599,7 +599,7 @@ client.fieldStats([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-field-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -642,7 +642,7 @@ client.get([params, [callback]])
Get a typed JSON document from the index based on its id.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-get.html[the elasticsearch docs] for more about this method.
.Get `/myindex/mytype/1`
[source,js]
@ -707,7 +707,7 @@ client.getScript([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-scripting.html[the elasticsearch docs] for more about this method.
// no examples
@ -743,7 +743,7 @@ client.getSource([params, [callback]])
Get the source of a document by its index, type and id.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-get.html[the elasticsearch docs] for more about this method.
// no examples
@ -796,7 +796,7 @@ client.getTemplate([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -834,7 +834,7 @@ Optimistic concurrency control is performed, when the `version` argument is spec
By default, the document will be available for `get()` actions immediately, but will only be available for searching after an index refresh (which can happen automatically or manually). See <<api-indices-refresh>>.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-index_.html[the elasticsearch docs] for more about this method.
.Create or update a document
[source,js]
@ -911,7 +911,7 @@ client.info([params, [callback]])
Get basic info from the current cluster.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/[the elasticsearch docs] for more about this method.
// no examples
@ -927,7 +927,7 @@ client.mget([params, [callback]])
Get multiple documents based on an index, type (optional) and ids. The body required by mget can take two forms: an array of document locations, or an array of document ids.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-multi-get.html[the elasticsearch docs] for more about this method.
.An array of doc locations. Useful for getting documents from different indices.
[source,js]
@ -994,7 +994,7 @@ client.mpercolate([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-percolate.html[the elasticsearch docs] for more about this method.
// no examples
@ -1031,7 +1031,7 @@ client.msearch([params, [callback]])
Execute several search requests within the same request.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-multi-search.html[the elasticsearch docs] for more about this method.
.Perform multiple different searches, the body is made up of meta/data pairs
[source,js]
@ -1081,7 +1081,7 @@ client.mtermvectors([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-multi-termvectors.html[the elasticsearch docs] for more about this method.
// no examples
@ -1138,7 +1138,7 @@ client.percolate([params, [callback]])
Match a document against registered percolator queries.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-percolate.html[the elasticsearch docs] for more about this method.
.First, Register queries named “alert-1” and “alert-2” for the “myindex” index
[source,js]
@ -1277,7 +1277,7 @@ client.ping([params, [callback]])
// no description
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/[the elasticsearch docs] for more about this method.
// no examples
@ -1293,7 +1293,7 @@ client.putScript([params, [callback]])
// no description
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-scripting.html[the elasticsearch docs] for more about this method.
// no examples
@ -1334,7 +1334,7 @@ client.putTemplate([params, [callback]])
// no description
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -1373,7 +1373,7 @@ client.reindex([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/plugins/master/plugins-reindex.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-reindex.html[the elasticsearch docs] for more about this method.
// no examples
@ -1434,7 +1434,7 @@ client.renderSearchTemplate([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -1457,7 +1457,7 @@ client.scroll([params, [callback]])
Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-request-scroll.html[the elasticsearch docs] for more about this method.
.Collect every title in the index that contains the word "test"
[source,js]
@ -1516,7 +1516,7 @@ TIP: https://github.com/fullscale/elastic.js[elastic.js], https://github.com/hol
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-search.html[the elasticsearch docs] for more about this method.
.Search with a simple query string query
[source,js]
@ -1661,7 +1661,7 @@ client.searchExists([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-exists.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-exists.html[the elasticsearch docs] for more about this method.
// no examples
@ -1722,7 +1722,7 @@ client.searchShards([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-shards.html[the elasticsearch docs] for more about this method.
// no examples
@ -1765,7 +1765,7 @@ client.searchTemplate([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -1818,7 +1818,7 @@ client.suggest([params, [callback]])
The suggest feature suggests similar looking terms based on a provided text by using a specific suggester.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-suggesters.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-suggesters.html[the elasticsearch docs] for more about this method.
.Return query terms suggestions (“auto-correction”)
[source,js]
@ -1890,7 +1890,7 @@ client.termvectors([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-termvectors.html[the elasticsearch docs] for more about this method.
// no examples
@ -1952,7 +1952,7 @@ Update parts of a document. The required body parameter can contain one of two t
* a partial document, which will be merged with the existing one.
* a `script` which will update the document content
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-update.html[the elasticsearch docs] for more about this method.
.Update document title using partial document
[source,js]
@ -2086,7 +2086,7 @@ client.updateByQuery([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/plugins/master/plugins-reindex.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-update-by-query.html[the elasticsearch docs] for more about this method.
// no examples
@ -2254,7 +2254,7 @@ client.cat.allocation([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-allocation.html[the elasticsearch docs] for more about this method.
// no examples
@ -2295,7 +2295,7 @@ client.cat.count([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-count.html[the elasticsearch docs] for more about this method.
// no examples
@ -2328,7 +2328,7 @@ client.cat.fielddata([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-fielddata.html[the elasticsearch docs] for more about this method.
// no examples
@ -2369,7 +2369,7 @@ client.cat.health([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-health.html[the elasticsearch docs] for more about this method.
// no examples
@ -2402,7 +2402,7 @@ client.cat.help([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat.html[the elasticsearch docs] for more about this method.
// no examples
@ -2425,7 +2425,7 @@ client.cat.indices([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-indices.html[the elasticsearch docs] for more about this method.
// no examples
@ -2468,7 +2468,7 @@ client.cat.master([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-master.html[the elasticsearch docs] for more about this method.
// no examples
@ -2499,7 +2499,7 @@ client.cat.nodeattrs([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-nodeattrs.html[the elasticsearch docs] for more about this method.
// no examples
@ -2530,7 +2530,7 @@ client.cat.nodes([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-nodes.html[the elasticsearch docs] for more about this method.
// no examples
@ -2561,7 +2561,7 @@ client.cat.pendingTasks([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-pending-tasks.html[the elasticsearch docs] for more about this method.
// no examples
@ -2592,7 +2592,7 @@ client.cat.plugins([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-plugins.html[the elasticsearch docs] for more about this method.
// no examples
@ -2623,7 +2623,7 @@ client.cat.recovery([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-recovery.html[the elasticsearch docs] for more about this method.
// no examples
@ -2662,7 +2662,7 @@ client.cat.repositories([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-repositories.html[the elasticsearch docs] for more about this method.
// no examples
@ -2693,7 +2693,7 @@ client.cat.segments([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-segments.html[the elasticsearch docs] for more about this method.
// no examples
@ -2722,7 +2722,7 @@ client.cat.shards([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-shards.html[the elasticsearch docs] for more about this method.
// no examples
@ -2755,7 +2755,7 @@ client.cat.snapshots([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -2788,7 +2788,7 @@ client.cat.threadPool([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cat-thread-pool.html[the elasticsearch docs] for more about this method.
// no examples
@ -2821,7 +2821,7 @@ client.cluster.getSettings([params, [callback]])
Get cluster settings (previously set with `putSettings()`)
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cluster-update-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -2848,7 +2848,7 @@ client.cluster.health([params, [callback]])
Get a very simple status on the health of the cluster.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cluster-health.html[the elasticsearch docs] for more about this method.
// no examples
@ -2897,7 +2897,7 @@ client.cluster.pendingTasks([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cluster-pending.html[the elasticsearch docs] for more about this method.
// no examples
@ -2922,7 +2922,7 @@ client.cluster.putSettings([params, [callback]])
Update cluster wide specific settings.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cluster-update-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -2949,7 +2949,7 @@ client.cluster.reroute([params, [callback]])
Explicitly execute a cluster reroute allocation command including specific commands.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cluster-reroute.html[the elasticsearch docs] for more about this method.
// no examples
@ -2980,7 +2980,7 @@ client.cluster.state([params, [callback]])
Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc).
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cluster-state.html[the elasticsearch docs] for more about this method.
// no examples
@ -3023,7 +3023,7 @@ client.cluster.stats([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cluster-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -3052,7 +3052,7 @@ client.indices.analyze([params, [callback]])
Perform the analysis process on a text and return the tokens breakdown of the text.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-analyze.html[the elasticsearch docs] for more about this method.
// no examples
@ -3103,7 +3103,7 @@ client.indices.clearCache([params, [callback]])
Clear either all caches or specific cached associated with one ore more indices.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-clearcache.html[the elasticsearch docs] for more about this method.
// no examples
@ -3151,7 +3151,7 @@ client.indices.close([params, [callback]])
Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-open-close.html[the elasticsearch docs] for more about this method.
// no examples
@ -3190,7 +3190,7 @@ client.indices.create([params, [callback]])
Create an index in Elasticsearch.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-create-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -3219,7 +3219,7 @@ client.indices.delete([params, [callback]])
Delete an index in Elasticsearch
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-delete-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -3246,7 +3246,7 @@ client.indices.deleteAlias([params, [callback]])
Delete a specific alias.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3275,7 +3275,7 @@ client.indices.deleteTemplate([params, [callback]])
Delete an index template by its name.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -3302,7 +3302,7 @@ client.indices.deleteWarmer([params, [callback]])
Delete an index warmer.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-warmers.html[the elasticsearch docs] for more about this method.
// no examples
@ -3329,7 +3329,7 @@ client.indices.exists([params, [callback]])
Return a boolean indicating whether given index exists.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-exists.html[the elasticsearch docs] for more about this method.
// no examples
@ -3366,7 +3366,7 @@ client.indices.existsAlias([params, [callback]])
Return a boolean indicating whether given alias exists.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3405,7 +3405,7 @@ client.indices.existsTemplate([params, [callback]])
// no description
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -3432,7 +3432,7 @@ client.indices.existsType([params, [callback]])
Check if a type/types exists in an index/indices.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html[the elasticsearch docs] for more about this method.
The default method is `HEAD` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-types-exists.html[the elasticsearch docs] for more about this method.
// no examples
@ -3471,7 +3471,7 @@ client.indices.flush([params, [callback]])
Explicitly flush one or more indices.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-flush.html[the elasticsearch docs] for more about this method.
// no examples
@ -3510,7 +3510,7 @@ client.indices.flushSynced([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-synced-flush.html[the elasticsearch docs] for more about this method.
// no examples
@ -3545,7 +3545,7 @@ client.indices.forcemerge([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-forcemerge.html[the elasticsearch docs] for more about this method.
// no examples
@ -3590,7 +3590,7 @@ client.indices.get([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-get-index.html[the elasticsearch docs] for more about this method.
// no examples
@ -3633,7 +3633,7 @@ client.indices.getAlias([params, [callback]])
Retrieve a specified alias.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3672,7 +3672,7 @@ client.indices.getAliases([params, [callback]])
Retrieve specified aliases
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -3701,7 +3701,7 @@ client.indices.getFieldMapping([params, [callback]])
Retrieve mapping definition of a specific field.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-get-field-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -3744,7 +3744,7 @@ client.indices.getMapping([params, [callback]])
Retrieve mapping definition of index or index/type.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-get-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -3783,7 +3783,7 @@ client.indices.getSettings([params, [callback]])
Retrieve settings for one or more (or all) indices.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-get-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -3826,7 +3826,7 @@ client.indices.getTemplate([params, [callback]])
Retrieve an index template by its name.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -3855,7 +3855,7 @@ client.indices.getUpgrade([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-upgrade.html[the elasticsearch docs] for more about this method.
// no examples
@ -3892,7 +3892,7 @@ client.indices.getWarmer([params, [callback]])
Retreieve an index warmer.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-warmers.html[the elasticsearch docs] for more about this method.
// no examples
@ -3933,7 +3933,7 @@ client.indices.open([params, [callback]])
Open a closed index, making it available for search.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-open-close.html[the elasticsearch docs] for more about this method.
// no examples
@ -3972,7 +3972,7 @@ client.indices.optimize([params, [callback]])
Explicitly optimize one or more indices.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-optimize.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-optimize.html[the elasticsearch docs] for more about this method.
// no examples
@ -4017,7 +4017,7 @@ client.indices.putAlias([params, [callback]])
Create an alias for a specific index/indices.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html[the elasticsearch docs] for more about this method.
// no examples
@ -4046,7 +4046,7 @@ client.indices.putMapping([params, [callback]])
Register specific mapping definition for a specific type.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-put-mapping.html[the elasticsearch docs] for more about this method.
// no examples
@ -4089,7 +4089,7 @@ client.indices.putSettings([params, [callback]])
Change specific index level settings in real time.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-update-settings.html[the elasticsearch docs] for more about this method.
// no examples
@ -4128,7 +4128,7 @@ client.indices.putTemplate([params, [callback]])
Create an index template that will automatically be applied to new indices created.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-templates.html[the elasticsearch docs] for more about this method.
// no examples
@ -4161,7 +4161,7 @@ client.indices.putWarmer([params, [callback]])
Create an index warmer to run registered search requests to warm up the index before it is available for search.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for more about this method.
The default method is `PUT` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-warmers.html[the elasticsearch docs] for more about this method.
// no examples
@ -4204,7 +4204,7 @@ client.indices.recovery([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-recovery.html[the elasticsearch docs] for more about this method.
// no examples
@ -4233,7 +4233,7 @@ client.indices.refresh([params, [callback]])
Explicitly refresh one or more index, making all operations performed since the last refresh available for search.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-refresh.html[the elasticsearch docs] for more about this method.
// no examples
@ -4272,7 +4272,7 @@ client.indices.segments([params, [callback]])
Retrieve low level segments information that a Lucene index (shard level) is built with.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-segments.html[the elasticsearch docs] for more about this method.
// no examples
@ -4313,7 +4313,7 @@ client.indices.shardStores([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-shards-stores.html[the elasticsearch docs] for more about this method.
// no examples
@ -4352,7 +4352,7 @@ client.indices.stats([params, [callback]])
Retrieve statistics on different operations happening on an index.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -4396,7 +4396,7 @@ client.indices.updateAliases([params, [callback]])
Update specified aliases.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html[the elasticsearch docs] for more about this method.
.Perform an atomic alias swap, for a rotating index
[source,js]
@ -4434,7 +4434,7 @@ client.indices.upgrade([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-upgrade.html[the elasticsearch docs] for more about this method.
// no examples
@ -4473,7 +4473,7 @@ client.indices.validateQuery([params, [callback]])
Validate a potentially expensive query without executing it.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-validate.html[the elasticsearch docs] for more about this method.
// no examples
@ -4534,7 +4534,7 @@ client.nodes.hotThreads([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cluster-nodes-hot-threads.html[the elasticsearch docs] for more about this method.
// no examples
@ -4574,7 +4574,7 @@ client.nodes.info([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cluster-nodes-info.html[the elasticsearch docs] for more about this method.
// no examples
@ -4605,7 +4605,7 @@ client.nodes.stats([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cluster-nodes-stats.html[the elasticsearch docs] for more about this method.
// no examples
@ -4653,7 +4653,7 @@ client.snapshot.create([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4682,7 +4682,7 @@ client.snapshot.createRepository([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4711,7 +4711,7 @@ client.snapshot.delete([params, [callback]])
// no description
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4738,7 +4738,7 @@ client.snapshot.deleteRepository([params, [callback]])
// no description
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4765,7 +4765,7 @@ client.snapshot.get([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4792,7 +4792,7 @@ client.snapshot.getRepository([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4819,7 +4819,7 @@ client.snapshot.restore([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4848,7 +4848,7 @@ client.snapshot.status([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4875,7 +4875,7 @@ client.snapshot.verifyRepository([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for more about this method.
// no examples
@ -4902,7 +4902,7 @@ client.tasks.cancel([params, [callback]])
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks-cancel.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/tasks.html#_task_cancellation[the elasticsearch docs] for more about this method.
// no examples
@ -4933,7 +4933,7 @@ client.tasks.list([params, [callback]])
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks-list.html[the elasticsearch docs] for more about this method.
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/tasks.html#_current_tasks_information[the elasticsearch docs] for more about this method.
// no examples