[api] regenerate
This commit is contained in:
spalger
@ -71,6 +71,8 @@ Options:::
|
||||
`String` -- The pipeline id to preprocess incoming documents with
|
||||
`index`::
|
||||
`String` -- Default index for items which don't provide one
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -94,6 +96,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`scrollId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -194,6 +198,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -251,6 +257,8 @@ Options:::
|
||||
`String` -- The type of the document being count percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -327,6 +335,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -390,6 +400,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -521,6 +533,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -546,6 +560,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -569,6 +585,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -620,6 +638,8 @@ client.exists({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -710,6 +730,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -753,6 +775,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1005,6 +1029,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1090,6 +1116,8 @@ client.mget({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1127,6 +1155,8 @@ Options:::
|
||||
`String` -- The index of the document being count percolated to use as default
|
||||
`type`::
|
||||
`String` -- The type of the document being percolated to use as default.
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1177,6 +1207,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1210,6 +1242,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1267,6 +1301,8 @@ Options:::
|
||||
`String` -- The index in which the document resides.
|
||||
`type`::
|
||||
`String` -- The type of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1406,6 +1442,8 @@ Options:::
|
||||
`String` -- The type of the document being percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1447,6 +1485,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1470,6 +1510,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1501,6 +1543,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Should the request should block until the reindex is complete.
|
||||
`requestsPerSecond`::
|
||||
`Number` -- The throttle to set on this request in sub-requests per second. -1 means set no throttle as does "unlimited" which is the only non-float this accepts.
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1526,6 +1570,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Number` -- The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
|
||||
`taskId`::
|
||||
`String` -- The task id to rethrottle
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1549,6 +1595,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- The id of the stored search template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1602,6 +1650,8 @@ client.search({
|
||||
`DurationString` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`scrollId`::
|
||||
`String` -- The scroll ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1751,6 +1801,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1794,6 +1846,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1845,6 +1899,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1917,6 +1973,8 @@ Options:::
|
||||
`String` -- Specific routing value
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1974,6 +2032,8 @@ Options:::
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document, when not specified a doc param should be supplied.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2112,6 +2172,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2223,6 +2285,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2961,6 +3025,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Return 'YES' decisions in explanation (default: false)
|
||||
`includeDiskInfo`::
|
||||
`Boolean` -- Return information about disk usage and shard sizes (default: false)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3101,6 +3167,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3134,6 +3202,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3253,6 +3323,8 @@ Options:::
|
||||
* `"detailed"`
|
||||
* `"text"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3300,6 +3372,8 @@ Options:::
|
||||
`Boolean` -- Clear the recycler cache
|
||||
`request`::
|
||||
`Boolean` -- Clear request cache
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3340,6 +3414,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma separated list of indices to close
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3371,6 +3447,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Whether to update the mapping for all fields with the same name across all types or not
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3398,6 +3476,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3427,6 +3507,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3454,6 +3536,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3491,6 +3575,8 @@ Options:::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3530,6 +3616,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to return
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3557,6 +3645,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3596,6 +3686,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3635,6 +3727,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3670,6 +3764,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3715,6 +3811,8 @@ Options:::
|
||||
`Boolean` -- Specify whether the request should block until the merge process is finished (default: true)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4031,6 +4129,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma separated list of indices to open
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4060,6 +4160,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4103,6 +4205,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4144,6 +4248,8 @@ Options:::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4177,6 +4283,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4245,6 +4353,8 @@ Options:::
|
||||
`Anything` -- TODO: ?
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4278,6 +4388,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The name of the alias to rollover
|
||||
`newIndex`::
|
||||
`String` -- The name of the rollover index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-rollover-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4389,6 +4501,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The name of the source index to shrink
|
||||
`target`::
|
||||
`String` -- The name of the target index to shrink into
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shrink-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4471,6 +4585,8 @@ client.indices.updateAliases({
|
||||
`DurationString` -- Request timeout
|
||||
`masterTimeout`::
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4510,6 +4626,8 @@ Options:::
|
||||
`Boolean` -- If true, only ancient (an older Lucene major release) segments will be upgraded
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4571,6 +4689,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4598,6 +4718,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`id`::
|
||||
`String` -- Pipeline ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4650,6 +4772,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`id`::
|
||||
`String` -- Pipeline ID
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4675,6 +4799,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Verbose mode. Display data output for each processor in executed pipeline
|
||||
`id`::
|
||||
`String` -- Pipeline ID
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4823,6 +4949,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4852,6 +4980,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Whether to verify the repository after creation
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4879,6 +5009,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4906,6 +5038,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String, String[], Boolean` -- A comma-separated list of repository names
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4991,6 +5125,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -5047,6 +5183,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -5078,6 +5216,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.
|
||||
`taskId`::
|
||||
`String` -- Cancel the task with specified task id (node_id:task_number)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
|
||||
@ -64,6 +64,8 @@ Options:::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`index`::
|
||||
`String` -- Default index for items which don't provide one
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -87,6 +89,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`scrollId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -165,6 +169,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -244,6 +250,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -310,6 +318,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -396,6 +406,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the operation
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -447,6 +459,8 @@ client.exists({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -539,6 +553,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -734,6 +750,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -817,6 +835,8 @@ client.mget({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -893,6 +913,8 @@ client.mlt({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-more-like-this.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -943,6 +965,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1043,6 +1067,8 @@ client.percolate({
|
||||
`String` -- The name of the index with a registered percolator query
|
||||
`type`::
|
||||
`String` -- The document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1114,6 +1140,8 @@ client.search({
|
||||
`DurationString` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`scrollId`::
|
||||
`String` -- The scroll ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1255,6 +1283,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1323,6 +1353,8 @@ Options:::
|
||||
`String` -- The URL-encoded request definition (instead of using request body)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1464,6 +1496,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1660,6 +1694,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Exit the JVM as well (default: true)
|
||||
`nodeId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-nodes-shutdown.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1804,6 +1840,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Simulate the operation only and return the resulting state
|
||||
`filterMetadata`::
|
||||
`Boolean` -- Don't return cluster state metadata (default: false)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1882,6 +1920,8 @@ Options:::
|
||||
* `"detailed"`
|
||||
* `"text"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1929,6 +1969,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index name to limit the operation
|
||||
`recycler`::
|
||||
`Boolean` -- Clear the recycler cache
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1957,6 +1999,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1984,6 +2028,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2011,6 +2057,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or empty string to delete all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2040,6 +2088,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- The name of the index with an alias
|
||||
`name`::
|
||||
`String` -- The name of the alias to be deleted
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2067,6 +2117,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` for all indices
|
||||
`type`::
|
||||
`String` -- The name of the document type to delete
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-delete-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2094,6 +2146,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2123,6 +2177,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- The name of the warmer (supports wildcards); leave empty to delete all warmers
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register warmer for; use `_all` or empty string to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2146,6 +2202,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
[horizontal]
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-get-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2177,6 +2235,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to return
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2208,6 +2268,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2243,6 +2305,8 @@ Options:::
|
||||
`Boolean` -- Refresh the index after performing the operation
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2453,6 +2517,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2494,6 +2560,8 @@ Options:::
|
||||
`Boolean` -- Specify whether the request should block until the merge process is finished (default: true)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2523,6 +2591,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String` -- The name of the index with an alias
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2554,6 +2624,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to perform the operation on all indices
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2579,6 +2651,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2608,6 +2682,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2637,6 +2713,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String` -- The name of the warmer
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2668,6 +2746,8 @@ Options:::
|
||||
`Anything` -- TODO: ?
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2728,6 +2808,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-gateway-snapshot.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2893,6 +2975,8 @@ client.indices.updateAliases({
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2932,5 +3016,7 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -66,6 +66,8 @@ Options:::
|
||||
`String` -- Default document type for items which don't provide one
|
||||
`index`::
|
||||
`String` -- Default index for items which don't provide one
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -89,6 +91,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`scrollId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -171,6 +175,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -224,6 +230,8 @@ Options:::
|
||||
`String` -- The type of the document being count percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -301,6 +309,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -367,6 +377,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -457,6 +469,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the operation
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -508,6 +522,8 @@ client.exists({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -600,6 +616,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -801,6 +819,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -884,6 +904,8 @@ client.mget({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -960,6 +982,8 @@ client.mlt({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-more-like-this.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -995,6 +1019,8 @@ Options:::
|
||||
`String` -- The index of the document being count percolated to use as default
|
||||
`type`::
|
||||
`String` -- The type of the document being percolated to use as default.
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1045,6 +1071,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1092,6 +1120,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1218,6 +1248,8 @@ Options:::
|
||||
`String` -- The type of the document being percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1289,6 +1321,8 @@ client.search({
|
||||
`Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`scrollId`::
|
||||
`String` -- The scroll ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1436,6 +1470,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1477,6 +1513,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1549,6 +1587,8 @@ Options:::
|
||||
`String` -- The URL-encoded request definition (instead of using request body)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1594,6 +1634,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1733,6 +1775,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2263,6 +2307,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
[horizontal]
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2292,6 +2338,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2393,6 +2441,8 @@ Options:::
|
||||
* `"detailed"`
|
||||
* `"text"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2444,6 +2494,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index name to limit the operation
|
||||
`recycler`::
|
||||
`Boolean` -- Clear the recycler cache
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2482,6 +2534,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2509,6 +2563,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2536,6 +2592,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2565,6 +2623,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2592,6 +2652,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-delete-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2619,6 +2681,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2646,6 +2710,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2681,6 +2747,8 @@ Options:::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2718,6 +2786,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to return
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2743,6 +2813,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2780,6 +2852,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2817,6 +2891,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3103,6 +3179,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3146,6 +3224,8 @@ Options:::
|
||||
`Boolean` -- Specify whether the request should block until the merge process is finished (default: true)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3175,6 +3255,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` or omit to perform the operation on all indices.
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3216,6 +3298,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3253,6 +3337,8 @@ Options:::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3284,6 +3370,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3323,6 +3411,8 @@ Options:::
|
||||
`String` -- The name of the warmer
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3360,6 +3450,8 @@ Options:::
|
||||
`Anything` -- TODO: ?
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3430,6 +3522,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-gateway-snapshot.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3553,6 +3647,8 @@ client.indices.updateAliases({
|
||||
`DurationString` -- Request timeout
|
||||
`masterTimeout`::
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3596,6 +3692,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3688,6 +3786,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Exit the JVM as well (default: true)
|
||||
`nodeId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-shutdown.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3763,6 +3863,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3790,6 +3892,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3817,6 +3921,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3844,6 +3950,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String, String[], Boolean` -- A comma-separated list of repository names
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3927,5 +4035,7 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -66,6 +66,8 @@ Options:::
|
||||
`String` -- Default document type for items which don't provide one
|
||||
`index`::
|
||||
`String` -- Default index for items which don't provide one
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -89,6 +91,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`scrollId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -171,6 +175,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -226,6 +232,8 @@ Options:::
|
||||
`String` -- The type of the document being count percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -305,6 +313,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -373,6 +383,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -463,6 +475,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the operation
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -514,6 +528,8 @@ client.exists({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -606,6 +622,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -813,6 +831,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -896,6 +916,8 @@ client.mget({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -972,6 +994,8 @@ client.mlt({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-more-like-this.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1007,6 +1031,8 @@ Options:::
|
||||
`String` -- The index of the document being count percolated to use as default
|
||||
`type`::
|
||||
`String` -- The type of the document being percolated to use as default.
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1057,6 +1083,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1104,6 +1132,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1232,6 +1262,8 @@ Options:::
|
||||
`String` -- The type of the document being percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1303,6 +1335,8 @@ client.search({
|
||||
`Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`scrollId`::
|
||||
`String` -- The scroll ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1450,6 +1484,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1491,6 +1527,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-shards.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1516,6 +1554,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1588,6 +1628,8 @@ Options:::
|
||||
`String` -- The URL-encoded request definition (instead of using request body)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1633,6 +1675,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1774,6 +1818,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2333,6 +2379,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
[horizontal]
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2364,6 +2412,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2467,6 +2517,8 @@ Options:::
|
||||
* `"detailed"`
|
||||
* `"text"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2518,6 +2570,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index name to limit the operation
|
||||
`recycler`::
|
||||
`Boolean` -- Clear the recycler cache
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2556,6 +2610,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2583,6 +2639,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2610,6 +2668,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2639,6 +2699,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2666,6 +2728,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-delete-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2693,6 +2757,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2720,6 +2786,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2755,6 +2823,8 @@ Options:::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-get-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2792,6 +2862,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to return
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2817,6 +2889,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2854,6 +2928,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2891,6 +2967,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3177,6 +3255,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3222,6 +3302,8 @@ Options:::
|
||||
`Boolean` -- Force a merge operation to run, even if there is a single segment in the index (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3251,6 +3333,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` or omit to perform the operation on all indices.
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3292,6 +3376,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3329,6 +3415,8 @@ Options:::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3360,6 +3448,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3399,6 +3489,8 @@ Options:::
|
||||
`String` -- The name of the warmer
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3465,6 +3557,8 @@ Options:::
|
||||
`Anything` -- TODO: ?
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3535,6 +3629,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-gateway-snapshot.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3658,6 +3754,8 @@ client.indices.updateAliases({
|
||||
`DurationString` -- Request timeout
|
||||
`masterTimeout`::
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3701,6 +3799,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3793,6 +3893,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Exit the JVM as well (default: true)
|
||||
`nodeId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/cluster-nodes-shutdown.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3868,6 +3970,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3895,6 +3999,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3922,6 +4028,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3949,6 +4057,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String, String[], Boolean` -- A comma-separated list of repository names
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4032,6 +4142,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.1/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
|
||||
@ -66,6 +66,8 @@ Options:::
|
||||
`String` -- Default document type for items which don't provide one
|
||||
`index`::
|
||||
`String` -- Default index for items which don't provide one
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -89,6 +91,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`scrollId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -171,6 +175,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -226,6 +232,8 @@ Options:::
|
||||
`String` -- The type of the document being count percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -305,6 +313,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -373,6 +383,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -463,6 +475,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the operation
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -514,6 +528,8 @@ client.exists({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -606,6 +622,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -813,6 +831,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -896,6 +916,8 @@ client.mget({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -972,6 +994,8 @@ client.mlt({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-more-like-this.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1007,6 +1031,8 @@ Options:::
|
||||
`String` -- The index of the document being count percolated to use as default
|
||||
`type`::
|
||||
`String` -- The type of the document being percolated to use as default.
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1057,6 +1083,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1104,6 +1132,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1232,6 +1262,8 @@ Options:::
|
||||
`String` -- The type of the document being percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1303,6 +1335,8 @@ client.search({
|
||||
`Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`scrollId`::
|
||||
`String` -- The scroll ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1450,6 +1484,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1491,6 +1527,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-shards.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1542,6 +1580,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1614,6 +1654,8 @@ Options:::
|
||||
`String` -- The URL-encoded request definition (instead of using request body)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1659,6 +1701,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1798,6 +1842,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2398,6 +2444,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
[horizontal]
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2429,6 +2477,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2530,6 +2580,8 @@ Options:::
|
||||
* `"detailed"`
|
||||
* `"text"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2581,6 +2633,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index name to limit the operation
|
||||
`recycler`::
|
||||
`Boolean` -- Clear the recycler cache
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2619,6 +2673,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2646,6 +2702,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2673,6 +2731,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2702,6 +2762,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2729,6 +2791,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-delete-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2756,6 +2820,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2783,6 +2849,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2818,6 +2886,8 @@ Options:::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-get-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2855,6 +2925,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to return
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2880,6 +2952,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2917,6 +2991,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2954,6 +3030,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3240,6 +3318,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3285,6 +3365,8 @@ Options:::
|
||||
`Boolean` -- Force a merge operation to run, even if there is a single segment in the index (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3314,6 +3396,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` or omit to perform the operation on all indices.
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3355,6 +3439,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3392,6 +3478,8 @@ Options:::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3423,6 +3511,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3462,6 +3552,8 @@ Options:::
|
||||
`String` -- The name of the warmer
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3528,6 +3620,8 @@ Options:::
|
||||
`Anything` -- TODO: ?
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3688,6 +3782,8 @@ client.indices.updateAliases({
|
||||
`DurationString` -- Request timeout
|
||||
`masterTimeout`::
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3731,6 +3827,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3823,6 +3921,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Exit the JVM as well (default: true)
|
||||
`nodeId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/cluster-nodes-shutdown.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3898,6 +3998,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3925,6 +4027,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3952,6 +4056,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3979,6 +4085,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String, String[], Boolean` -- A comma-separated list of repository names
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4062,6 +4170,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.2/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
|
||||
@ -66,6 +66,8 @@ Options:::
|
||||
`String` -- Default document type for items which don't provide one
|
||||
`index`::
|
||||
`String` -- Default index for items which don't provide one
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -89,6 +91,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`scrollId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -171,6 +175,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -226,6 +232,8 @@ Options:::
|
||||
`String` -- The type of the document being count percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -305,6 +313,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -373,6 +383,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -463,6 +475,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the operation
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -488,6 +502,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -511,6 +527,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -562,6 +580,8 @@ client.exists({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -654,6 +674,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -909,6 +931,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -992,6 +1016,8 @@ client.mget({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1068,6 +1094,8 @@ client.mlt({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-more-like-this.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1103,6 +1131,8 @@ Options:::
|
||||
`String` -- The index of the document being count percolated to use as default
|
||||
`type`::
|
||||
`String` -- The type of the document being percolated to use as default.
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1153,6 +1183,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1200,6 +1232,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1328,6 +1362,8 @@ Options:::
|
||||
`String` -- The type of the document being percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1369,6 +1405,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1392,6 +1430,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1447,6 +1487,8 @@ client.search({
|
||||
`Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`scrollId`::
|
||||
`String` -- The scroll ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1596,6 +1638,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1637,6 +1681,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-shards.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1688,6 +1734,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1760,6 +1808,8 @@ Options:::
|
||||
`String` -- The URL-encoded request definition (instead of using request body)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-suggesters.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1805,6 +1855,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1944,6 +1996,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2573,6 +2627,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
[horizontal]
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2604,6 +2660,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2705,6 +2763,8 @@ Options:::
|
||||
* `"detailed"`
|
||||
* `"text"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2756,6 +2816,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index name to limit the operation
|
||||
`recycler`::
|
||||
`Boolean` -- Clear the recycler cache
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2794,6 +2856,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2821,6 +2885,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2848,6 +2914,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2877,6 +2945,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2904,6 +2974,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-delete-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2931,6 +3003,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2958,6 +3032,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2993,6 +3069,8 @@ Options:::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-get-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3030,6 +3108,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to return
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3055,6 +3135,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3092,6 +3174,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3129,6 +3213,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3411,6 +3497,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3456,6 +3544,8 @@ Options:::
|
||||
`Boolean` -- Force a merge operation to run, even if there is a single segment in the index (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3485,6 +3575,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` or omit to perform the operation on all indices.
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3526,6 +3618,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3563,6 +3657,8 @@ Options:::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3596,6 +3692,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3635,6 +3733,8 @@ Options:::
|
||||
`String` -- The name of the warmer
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3701,6 +3801,8 @@ Options:::
|
||||
`Anything` -- TODO: ?
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3861,6 +3963,8 @@ client.indices.updateAliases({
|
||||
`DurationString` -- Request timeout
|
||||
`masterTimeout`::
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3904,6 +4008,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3996,6 +4102,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Exit the JVM as well (default: true)
|
||||
`nodeId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/cluster-nodes-shutdown.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4071,6 +4179,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4098,6 +4208,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4125,6 +4237,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4152,6 +4266,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String, String[], Boolean` -- A comma-separated list of repository names
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4235,6 +4351,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
|
||||
@ -66,6 +66,8 @@ Options:::
|
||||
`String` -- Default document type for items which don't provide one
|
||||
`index`::
|
||||
`String` -- Default index for items which don't provide one
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -89,6 +91,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`scrollId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -173,6 +177,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -232,6 +238,8 @@ Options:::
|
||||
`String` -- The type of the document being count percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -311,6 +319,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -379,6 +389,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -471,6 +483,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the operation
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -506,6 +520,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -539,6 +555,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -590,6 +608,8 @@ client.exists({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -682,6 +702,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -957,6 +979,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1042,6 +1066,8 @@ client.mget({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1118,6 +1144,8 @@ client.mlt({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-more-like-this.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1157,6 +1185,8 @@ Options:::
|
||||
`String` -- The index of the document being count percolated to use as default
|
||||
`type`::
|
||||
`String` -- The type of the document being percolated to use as default.
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1209,6 +1239,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1256,6 +1288,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The index in which the document resides.
|
||||
`type`::
|
||||
`String` -- The type of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1397,6 +1431,8 @@ Options:::
|
||||
`String` -- The type of the document being percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1454,6 +1490,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1493,6 +1531,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1550,6 +1590,8 @@ client.search({
|
||||
`Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`scrollId`::
|
||||
`String` -- The scroll ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1705,6 +1747,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1750,6 +1794,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1793,6 +1839,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-shards.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1848,6 +1896,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1922,6 +1972,8 @@ Options:::
|
||||
`String` -- The URL-encoded request definition (instead of using request body)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-suggesters.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1969,6 +2021,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document, when not specified a doc param should be supplied.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2112,6 +2166,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2741,6 +2797,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
[horizontal]
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2772,6 +2830,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2875,6 +2935,8 @@ Options:::
|
||||
* `"detailed"`
|
||||
* `"text"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2930,6 +2992,8 @@ Options:::
|
||||
`Boolean` -- Clear the recycler cache
|
||||
`queryCache`::
|
||||
`Boolean` -- Clear query cache
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2970,6 +3034,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2997,6 +3063,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3024,6 +3092,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3053,6 +3123,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3080,6 +3152,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-delete-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3107,6 +3181,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3134,6 +3210,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3171,6 +3249,8 @@ Options:::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3210,6 +3290,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to return
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3235,6 +3317,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3274,6 +3358,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3315,6 +3401,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3689,6 +3777,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3736,6 +3826,8 @@ Options:::
|
||||
`Boolean` -- Force a merge operation to run, even if there is a single segment in the index (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3765,6 +3857,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` or omit to perform the operation on all indices.
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3808,6 +3902,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3847,6 +3943,8 @@ Options:::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3880,6 +3978,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3921,6 +4021,8 @@ Options:::
|
||||
`String` -- The name of the warmer
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3989,6 +4091,8 @@ Options:::
|
||||
`Anything` -- TODO: ?
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4153,6 +4257,8 @@ client.indices.updateAliases({
|
||||
`DurationString` -- Request timeout
|
||||
`masterTimeout`::
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4190,6 +4296,8 @@ Options:::
|
||||
`Boolean` -- Specify whether the request should block until the all segments are upgraded (default: true)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4235,6 +4343,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4327,6 +4437,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Exit the JVM as well (default: true)
|
||||
`nodeId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/cluster-nodes-shutdown.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4402,6 +4514,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4431,6 +4545,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Whether to verify the repository after creation
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4458,6 +4574,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4485,6 +4603,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String, String[], Boolean` -- A comma-separated list of repository names
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4568,6 +4688,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4622,5 +4744,7 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -66,6 +66,8 @@ Options:::
|
||||
`String` -- Default document type for items which don't provide one
|
||||
`index`::
|
||||
`String` -- Default index for items which don't provide one
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -89,6 +91,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`scrollId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -173,6 +177,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -232,6 +238,8 @@ Options:::
|
||||
`String` -- The type of the document being count percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -311,6 +319,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -379,6 +389,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -471,6 +483,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the operation
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -506,6 +520,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -539,6 +555,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -590,6 +608,8 @@ client.exists({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -682,6 +702,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -957,6 +979,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1042,6 +1066,8 @@ client.mget({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1118,6 +1144,8 @@ client.mlt({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-more-like-this.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1157,6 +1185,8 @@ Options:::
|
||||
`String` -- The index of the document being count percolated to use as default
|
||||
`type`::
|
||||
`String` -- The type of the document being percolated to use as default.
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1209,6 +1239,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1260,6 +1292,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1401,6 +1435,8 @@ Options:::
|
||||
`String` -- The type of the document being percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1458,6 +1494,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1497,6 +1535,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1554,6 +1594,8 @@ client.search({
|
||||
`Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`scrollId`::
|
||||
`String` -- The scroll ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1707,6 +1749,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1752,6 +1796,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1795,6 +1841,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-shards.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1850,6 +1898,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1924,6 +1974,8 @@ Options:::
|
||||
`String` -- The URL-encoded request definition (instead of using request body)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-suggesters.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1973,6 +2025,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2116,6 +2170,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2749,6 +2805,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2780,6 +2838,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2895,6 +2955,8 @@ Options:::
|
||||
* `"detailed"`
|
||||
* `"text"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2950,6 +3012,8 @@ Options:::
|
||||
`Boolean` -- Clear the recycler cache
|
||||
`queryCache`::
|
||||
`Boolean` -- Clear query cache
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2990,6 +3054,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3017,6 +3083,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3044,6 +3112,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3073,6 +3143,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3100,6 +3172,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-delete-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3127,6 +3201,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3154,6 +3230,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3191,6 +3269,8 @@ Options:::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3230,6 +3310,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to return
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3257,6 +3339,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3296,6 +3380,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3335,6 +3421,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3711,6 +3799,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3758,6 +3848,8 @@ Options:::
|
||||
`Boolean` -- Force a merge operation to run, even if there is a single segment in the index (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3787,6 +3879,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3830,6 +3924,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3869,6 +3965,8 @@ Options:::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3902,6 +4000,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3943,6 +4043,8 @@ Options:::
|
||||
`String` -- The name of the warmer
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4011,6 +4113,8 @@ Options:::
|
||||
`Anything` -- TODO: ?
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4175,6 +4279,8 @@ client.indices.updateAliases({
|
||||
`DurationString` -- Request timeout
|
||||
`masterTimeout`::
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4212,6 +4318,8 @@ Options:::
|
||||
`Boolean` -- Specify whether the request should block until the all segments are upgraded (default: true)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4257,6 +4365,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4351,6 +4461,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Exit the JVM as well (default: true)
|
||||
`nodeId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/cluster-nodes-shutdown.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4426,6 +4538,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4455,6 +4569,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Whether to verify the repository after creation
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4482,6 +4598,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4509,6 +4627,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String, String[], Boolean` -- A comma-separated list of repository names
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4592,6 +4712,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4646,5 +4768,7 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.5/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -66,6 +66,8 @@ Options:::
|
||||
`String` -- Default document type for items which don't provide one
|
||||
`index`::
|
||||
`String` -- Default index for items which don't provide one
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -89,6 +91,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`scrollId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -189,6 +193,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -246,6 +252,8 @@ Options:::
|
||||
`String` -- The type of the document being count percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -325,6 +333,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -393,6 +403,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -483,6 +495,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the operation
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -518,6 +532,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -551,6 +567,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -602,6 +620,8 @@ client.exists({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -692,6 +712,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -735,6 +757,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-field-stats.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1010,6 +1034,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1093,6 +1119,8 @@ client.mget({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1167,6 +1195,8 @@ client.mlt({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-more-like-this.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1204,6 +1234,8 @@ Options:::
|
||||
`String` -- The index of the document being count percolated to use as default
|
||||
`type`::
|
||||
`String` -- The type of the document being percolated to use as default.
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1254,6 +1286,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1303,6 +1337,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1442,6 +1478,8 @@ Options:::
|
||||
`String` -- The type of the document being percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1499,6 +1537,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1538,6 +1578,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1593,6 +1635,8 @@ client.search({
|
||||
`Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`scrollId`::
|
||||
`String` -- The scroll ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1742,6 +1786,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1803,6 +1849,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1846,6 +1894,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-shards.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1899,6 +1949,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1971,6 +2023,8 @@ Options:::
|
||||
`String` -- Specific routing value
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-suggesters.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2018,6 +2072,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2161,6 +2217,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2794,6 +2852,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2825,6 +2885,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2938,6 +3000,8 @@ Options:::
|
||||
* `"detailed"`
|
||||
* `"text"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2993,6 +3057,8 @@ Options:::
|
||||
`Boolean` -- Clear the recycler cache
|
||||
`queryCache`::
|
||||
`Boolean` -- Clear query cache
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3033,6 +3099,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3060,6 +3128,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3087,6 +3157,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3116,6 +3188,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3143,6 +3217,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-delete-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3170,6 +3246,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3197,6 +3275,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3234,6 +3314,8 @@ Options:::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3273,6 +3355,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to return
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3300,6 +3384,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3339,6 +3425,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3378,6 +3466,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3413,6 +3503,8 @@ Options:::
|
||||
* `"none"`
|
||||
* `"all"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3789,6 +3881,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3836,6 +3930,8 @@ Options:::
|
||||
`Boolean` -- Force a merge operation to run, even if there is a single segment in the index (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3865,6 +3961,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3908,6 +4006,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3947,6 +4047,8 @@ Options:::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3980,6 +4082,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4021,6 +4125,8 @@ Options:::
|
||||
`String` -- The name of the warmer
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4089,6 +4195,8 @@ Options:::
|
||||
`Anything` -- TODO: ?
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4253,6 +4361,8 @@ client.indices.updateAliases({
|
||||
`DurationString` -- Request timeout
|
||||
`masterTimeout`::
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4292,6 +4402,8 @@ Options:::
|
||||
`Boolean` -- If true, only ancient (an older Lucene major release) segments will be upgraded
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4353,6 +4465,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4447,6 +4561,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Exit the JVM as well (default: true)
|
||||
`nodeId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-nodes-shutdown.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4522,6 +4638,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4551,6 +4669,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Whether to verify the repository after creation
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4578,6 +4698,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4605,6 +4727,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String, String[], Boolean` -- A comma-separated list of repository names
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4688,6 +4812,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4742,5 +4868,7 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -66,6 +66,8 @@ Options:::
|
||||
`String` -- Default document type for items which don't provide one
|
||||
`index`::
|
||||
`String` -- Default index for items which don't provide one
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -89,6 +91,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`scrollId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -189,6 +193,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -246,6 +252,8 @@ Options:::
|
||||
`String` -- The type of the document being count percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -325,6 +333,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -393,6 +403,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -483,6 +495,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the operation
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -518,6 +532,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -551,6 +567,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -602,6 +620,8 @@ client.exists({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -692,6 +712,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -735,6 +757,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-field-stats.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1010,6 +1034,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1093,6 +1119,8 @@ client.mget({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1167,6 +1195,8 @@ client.mlt({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-more-like-this.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1204,6 +1234,8 @@ Options:::
|
||||
`String` -- The index of the document being count percolated to use as default
|
||||
`type`::
|
||||
`String` -- The type of the document being percolated to use as default.
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1254,6 +1286,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1301,6 +1335,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The index in which the document resides.
|
||||
`type`::
|
||||
`String` -- The type of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1440,6 +1476,8 @@ Options:::
|
||||
`String` -- The type of the document being percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1497,6 +1535,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1536,6 +1576,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1591,6 +1633,8 @@ client.search({
|
||||
`DurationString` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`scrollId`::
|
||||
`String` -- The scroll ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1740,6 +1784,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1801,6 +1847,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1844,6 +1892,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.7/search-shards.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1897,6 +1947,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1969,6 +2021,8 @@ Options:::
|
||||
`String` -- Specific routing value
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-suggesters.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2016,6 +2070,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2159,6 +2215,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2792,6 +2850,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2823,6 +2883,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2938,6 +3000,8 @@ Options:::
|
||||
* `"detailed"`
|
||||
* `"text"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2993,6 +3057,8 @@ Options:::
|
||||
`Boolean` -- Clear the recycler cache
|
||||
`queryCache`::
|
||||
`Boolean` -- Clear query cache
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3033,6 +3099,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3060,6 +3128,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3087,6 +3157,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3116,6 +3188,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3143,6 +3217,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-delete-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3170,6 +3246,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3197,6 +3275,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3234,6 +3314,8 @@ Options:::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3273,6 +3355,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to return
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3300,6 +3384,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3339,6 +3425,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3378,6 +3466,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3413,6 +3503,8 @@ Options:::
|
||||
* `"none"`
|
||||
* `"all"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3789,6 +3881,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3836,6 +3930,8 @@ Options:::
|
||||
`Boolean` -- Force a merge operation to run, even if there is a single segment in the index (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3865,6 +3961,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3908,6 +4006,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3947,6 +4047,8 @@ Options:::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3980,6 +4082,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4021,6 +4125,8 @@ Options:::
|
||||
`String` -- The name of the warmer
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4089,6 +4195,8 @@ Options:::
|
||||
`Anything` -- TODO: ?
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4253,6 +4361,8 @@ client.indices.updateAliases({
|
||||
`DurationString` -- Request timeout
|
||||
`masterTimeout`::
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4292,6 +4402,8 @@ Options:::
|
||||
`Boolean` -- If true, only ancient (an older Lucene major release) segments will be upgraded
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4353,6 +4465,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4451,6 +4565,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Exit the JVM as well (default: true)
|
||||
`nodeId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/cluster-nodes-shutdown.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4528,6 +4644,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4557,6 +4675,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Whether to verify the repository after creation
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4584,6 +4704,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4611,6 +4733,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String, String[], Boolean` -- A comma-separated list of repository names
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4694,6 +4818,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.6/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4748,5 +4874,7 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/1.7/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -62,6 +62,8 @@ Options:::
|
||||
`String, String[], Boolean` -- Default comma-separated list of fields to return in the response for updates
|
||||
`index`::
|
||||
`String` -- Default index for items which don't provide one
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -85,6 +87,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`scrollId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -185,6 +189,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -242,6 +248,8 @@ Options:::
|
||||
`String` -- The type of the document being count percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -315,6 +323,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -377,6 +387,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -412,6 +424,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -445,6 +459,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -496,6 +512,8 @@ client.exists({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -586,6 +604,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -629,6 +649,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-field-stats.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -898,6 +920,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -981,6 +1005,8 @@ client.mget({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1018,6 +1044,8 @@ Options:::
|
||||
`String` -- The index of the document being count percolated to use as default
|
||||
`type`::
|
||||
`String` -- The type of the document being percolated to use as default.
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1068,6 +1096,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1125,6 +1155,8 @@ Options:::
|
||||
`String` -- The index in which the document resides.
|
||||
`type`::
|
||||
`String` -- The type of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1264,6 +1296,8 @@ Options:::
|
||||
`String` -- The type of the document being percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1321,6 +1355,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1360,6 +1396,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1383,6 +1421,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- The id of the stored search template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/2.0/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1438,6 +1478,8 @@ client.search({
|
||||
`Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`scrollId`::
|
||||
`String` -- The scroll ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1587,6 +1629,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1648,6 +1692,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1691,6 +1737,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-shards.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1744,6 +1792,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1816,6 +1866,8 @@ Options:::
|
||||
`String` -- Specific routing value
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-suggesters.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1875,6 +1927,8 @@ Options:::
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document, when not specified a doc param should be supplied.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2012,6 +2066,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2676,6 +2732,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2707,6 +2765,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2822,6 +2882,8 @@ Options:::
|
||||
* `"detailed"`
|
||||
* `"text"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2869,6 +2931,8 @@ Options:::
|
||||
`Boolean` -- Clear the recycler cache
|
||||
`request`::
|
||||
`Boolean` -- Clear request cache
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2909,6 +2973,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma separated list of indices to close
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2938,6 +3004,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Whether to update the mapping for all fields with the same name across all types or not
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2965,6 +3033,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2994,6 +3064,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3021,6 +3093,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3048,6 +3122,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3085,6 +3161,8 @@ Options:::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3124,6 +3202,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to return
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3151,6 +3231,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3190,6 +3272,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3229,6 +3313,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3264,6 +3350,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3646,6 +3734,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma separated list of indices to open
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3691,6 +3781,8 @@ Options:::
|
||||
`Boolean` -- Specify whether the request should block until the merge process is finished (default: true)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3720,6 +3812,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3763,6 +3857,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3802,6 +3898,8 @@ Options:::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3835,6 +3933,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3878,6 +3978,8 @@ Options:::
|
||||
`String` -- The name of the warmer
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3946,6 +4048,8 @@ Options:::
|
||||
`Anything` -- TODO: ?
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4108,6 +4212,8 @@ client.indices.updateAliases({
|
||||
`DurationString` -- Request timeout
|
||||
`masterTimeout`::
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4147,6 +4253,8 @@ Options:::
|
||||
`Boolean` -- If true, only ancient (an older Lucene major release) segments will be upgraded
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4208,6 +4316,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4356,6 +4466,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4385,6 +4497,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Whether to verify the repository after creation
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4412,6 +4526,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4439,6 +4555,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String, String[], Boolean` -- A comma-separated list of repository names
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4522,6 +4640,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4576,5 +4696,7 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.0/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -62,6 +62,8 @@ Options:::
|
||||
`String, String[], Boolean` -- Default comma-separated list of fields to return in the response for updates
|
||||
`index`::
|
||||
`String` -- Default index for items which don't provide one
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -85,6 +87,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`scrollId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -185,6 +189,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -242,6 +248,8 @@ Options:::
|
||||
`String` -- The type of the document being count percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -315,6 +323,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -377,6 +387,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -412,6 +424,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -445,6 +459,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -496,6 +512,8 @@ client.exists({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -586,6 +604,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -629,6 +649,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-field-stats.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -898,6 +920,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -981,6 +1005,8 @@ client.mget({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1018,6 +1044,8 @@ Options:::
|
||||
`String` -- The index of the document being count percolated to use as default
|
||||
`type`::
|
||||
`String` -- The type of the document being percolated to use as default.
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1068,6 +1096,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1125,6 +1155,8 @@ Options:::
|
||||
`String` -- The index in which the document resides.
|
||||
`type`::
|
||||
`String` -- The type of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1264,6 +1296,8 @@ Options:::
|
||||
`String` -- The type of the document being percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1321,6 +1355,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1360,6 +1396,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1383,6 +1421,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- The id of the stored search template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1438,6 +1478,8 @@ client.search({
|
||||
`Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`scrollId`::
|
||||
`String` -- The scroll ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1587,6 +1629,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1648,6 +1692,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1691,6 +1737,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-shards.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1744,6 +1792,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1816,6 +1866,8 @@ Options:::
|
||||
`String` -- Specific routing value
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-suggesters.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1875,6 +1927,8 @@ Options:::
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document, when not specified a doc param should be supplied.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2012,6 +2066,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2738,6 +2794,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2769,6 +2827,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2884,6 +2944,8 @@ Options:::
|
||||
* `"detailed"`
|
||||
* `"text"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2931,6 +2993,8 @@ Options:::
|
||||
`Boolean` -- Clear the recycler cache
|
||||
`request`::
|
||||
`Boolean` -- Clear request cache
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2971,6 +3035,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma separated list of indices to close
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3000,6 +3066,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Whether to update the mapping for all fields with the same name across all types or not
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3027,6 +3095,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3056,6 +3126,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3083,6 +3155,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3110,6 +3184,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3147,6 +3223,8 @@ Options:::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3186,6 +3264,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to return
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3213,6 +3293,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3252,6 +3334,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3291,6 +3375,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3326,6 +3412,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3371,6 +3459,8 @@ Options:::
|
||||
`Boolean` -- Specify whether the request should block until the merge process is finished (default: true)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3753,6 +3843,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma separated list of indices to open
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3798,6 +3890,8 @@ Options:::
|
||||
`Boolean` -- Specify whether the request should block until the merge process is finished (default: true)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3827,6 +3921,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3870,6 +3966,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3909,6 +4007,8 @@ Options:::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3942,6 +4042,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3985,6 +4087,8 @@ Options:::
|
||||
`String` -- The name of the warmer
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4053,6 +4157,8 @@ Options:::
|
||||
`Anything` -- TODO: ?
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4215,6 +4321,8 @@ client.indices.updateAliases({
|
||||
`DurationString` -- Request timeout
|
||||
`masterTimeout`::
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4254,6 +4362,8 @@ Options:::
|
||||
`Boolean` -- If true, only ancient (an older Lucene major release) segments will be upgraded
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4315,6 +4425,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4463,6 +4575,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4492,6 +4606,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Whether to verify the repository after creation
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4519,6 +4635,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4546,6 +4664,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String, String[], Boolean` -- A comma-separated list of repository names
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4629,6 +4749,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4683,5 +4805,7 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.1/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -62,6 +62,8 @@ Options:::
|
||||
`String, String[], Boolean` -- Default comma-separated list of fields to return in the response for updates
|
||||
`index`::
|
||||
`String` -- Default index for items which don't provide one
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -85,6 +87,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`scrollId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -185,6 +189,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -242,6 +248,8 @@ Options:::
|
||||
`String` -- The type of the document being count percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -315,6 +323,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -377,6 +387,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -412,6 +424,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -445,6 +459,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -496,6 +512,8 @@ client.exists({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -586,6 +604,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -629,6 +649,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -898,6 +920,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -981,6 +1005,8 @@ client.mget({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1018,6 +1044,8 @@ Options:::
|
||||
`String` -- The index of the document being count percolated to use as default
|
||||
`type`::
|
||||
`String` -- The type of the document being percolated to use as default.
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1068,6 +1096,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1125,6 +1155,8 @@ Options:::
|
||||
`String` -- The index in which the document resides.
|
||||
`type`::
|
||||
`String` -- The type of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1264,6 +1296,8 @@ Options:::
|
||||
`String` -- The type of the document being percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1321,6 +1355,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1360,6 +1396,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1383,6 +1421,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- The id of the stored search template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1438,6 +1478,8 @@ client.search({
|
||||
`Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`scrollId`::
|
||||
`String` -- The scroll ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1587,6 +1629,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1648,6 +1692,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.1/search-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1691,6 +1737,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1744,6 +1792,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1816,6 +1866,8 @@ Options:::
|
||||
`String` -- Specific routing value
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-suggesters.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1875,6 +1927,8 @@ Options:::
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document, when not specified a doc param should be supplied.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2012,6 +2066,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2740,6 +2796,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2771,6 +2829,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2890,6 +2950,8 @@ Options:::
|
||||
* `"detailed"`
|
||||
* `"text"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2937,6 +2999,8 @@ Options:::
|
||||
`Boolean` -- Clear the recycler cache
|
||||
`request`::
|
||||
`Boolean` -- Clear request cache
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2977,6 +3041,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma separated list of indices to close
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3006,6 +3072,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Whether to update the mapping for all fields with the same name across all types or not
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3033,6 +3101,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3062,6 +3132,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3089,6 +3161,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3116,6 +3190,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3153,6 +3229,8 @@ Options:::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3192,6 +3270,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to return
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3219,6 +3299,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3258,6 +3340,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3297,6 +3381,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3332,6 +3418,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3377,6 +3465,8 @@ Options:::
|
||||
`Boolean` -- Specify whether the request should block until the merge process is finished (default: true)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3759,6 +3849,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma separated list of indices to open
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3804,6 +3896,8 @@ Options:::
|
||||
`Boolean` -- Specify whether the request should block until the merge process is finished (default: true)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3833,6 +3927,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3876,6 +3972,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3915,6 +4013,8 @@ Options:::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3948,6 +4048,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3991,6 +4093,8 @@ Options:::
|
||||
`String` -- The name of the warmer
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4059,6 +4163,8 @@ Options:::
|
||||
`Anything` -- TODO: ?
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4221,6 +4327,8 @@ client.indices.updateAliases({
|
||||
`DurationString` -- Request timeout
|
||||
`masterTimeout`::
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4260,6 +4368,8 @@ Options:::
|
||||
`Boolean` -- If true, only ancient (an older Lucene major release) segments will be upgraded
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4321,6 +4431,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4469,6 +4581,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4498,6 +4612,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Whether to verify the repository after creation
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4525,6 +4641,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4552,6 +4670,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String, String[], Boolean` -- A comma-separated list of repository names
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4635,6 +4755,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4689,5 +4811,7 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -62,6 +62,8 @@ Options:::
|
||||
`String, String[], Boolean` -- Default comma-separated list of fields to return in the response for updates
|
||||
`index`::
|
||||
`String` -- Default index for items which don't provide one
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -85,6 +87,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`scrollId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -185,6 +189,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -242,6 +248,8 @@ Options:::
|
||||
`String` -- The type of the document being count percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -315,6 +323,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -377,6 +387,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -412,6 +424,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -445,6 +459,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -496,6 +512,8 @@ client.exists({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -586,6 +604,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -629,6 +649,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-field-stats.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -898,6 +920,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -981,6 +1005,8 @@ client.mget({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1018,6 +1044,8 @@ Options:::
|
||||
`String` -- The index of the document being count percolated to use as default
|
||||
`type`::
|
||||
`String` -- The type of the document being percolated to use as default.
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1068,6 +1096,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1125,6 +1155,8 @@ Options:::
|
||||
`String` -- The index in which the document resides.
|
||||
`type`::
|
||||
`String` -- The type of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1264,6 +1296,8 @@ Options:::
|
||||
`String` -- The type of the document being percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1321,6 +1355,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1360,6 +1396,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1394,6 +1432,8 @@ Options:::
|
||||
|
||||
`waitForCompletion`::
|
||||
`Boolean` -- Should the request should block until the reindex is complete.
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-reindex.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1417,6 +1457,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- The id of the stored search template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/2.3/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1472,6 +1514,8 @@ client.search({
|
||||
`Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`scrollId`::
|
||||
`String` -- The scroll ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1621,6 +1665,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1682,6 +1728,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1725,6 +1773,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-shards.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1778,6 +1828,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1850,6 +1902,8 @@ Options:::
|
||||
`String` -- Specific routing value
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-suggesters.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1909,6 +1963,8 @@ Options:::
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document, when not specified a doc param should be supplied.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2046,6 +2102,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2179,6 +2237,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.3/docs-update-by-query.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2907,6 +2967,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2938,6 +3000,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3061,6 +3125,8 @@ Options:::
|
||||
* `"detailed"`
|
||||
* `"text"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3108,6 +3174,8 @@ Options:::
|
||||
`Boolean` -- Clear the recycler cache
|
||||
`request`::
|
||||
`Boolean` -- Clear request cache
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3148,6 +3216,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma separated list of indices to close
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3177,6 +3247,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Whether to update the mapping for all fields with the same name across all types or not
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3204,6 +3276,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3233,6 +3307,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3260,6 +3336,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3287,6 +3365,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3324,6 +3404,8 @@ Options:::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3363,6 +3445,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to return
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3390,6 +3474,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3429,6 +3515,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3468,6 +3556,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3503,6 +3593,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3548,6 +3640,8 @@ Options:::
|
||||
`Boolean` -- Specify whether the request should block until the merge process is finished (default: true)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3930,6 +4024,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma separated list of indices to open
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3975,6 +4071,8 @@ Options:::
|
||||
`Boolean` -- Specify whether the request should block until the merge process is finished (default: true)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4004,6 +4102,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4047,6 +4147,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4086,6 +4188,8 @@ Options:::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4119,6 +4223,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4162,6 +4268,8 @@ Options:::
|
||||
`String` -- The name of the warmer
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4230,6 +4338,8 @@ Options:::
|
||||
`Anything` -- TODO: ?
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4392,6 +4502,8 @@ client.indices.updateAliases({
|
||||
`DurationString` -- Request timeout
|
||||
`masterTimeout`::
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4431,6 +4543,8 @@ Options:::
|
||||
`Boolean` -- If true, only ancient (an older Lucene major release) segments will be upgraded
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4492,6 +4606,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4640,6 +4756,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4669,6 +4787,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Whether to verify the repository after creation
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4696,6 +4816,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4723,6 +4845,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String, String[], Boolean` -- A comma-separated list of repository names
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4806,6 +4930,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4860,6 +4986,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4891,6 +5019,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.
|
||||
`taskId`::
|
||||
`String` -- Cancel the task with specified task id (node_id:task_number)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/2.3/tasks.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
|
||||
@ -62,6 +62,8 @@ Options:::
|
||||
`String, String[], Boolean` -- Default comma-separated list of fields to return in the response for updates
|
||||
`index`::
|
||||
`String` -- Default index for items which don't provide one
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-bulk.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -85,6 +87,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
[horizontal]
|
||||
`scrollId`::
|
||||
`String, String[], Boolean` -- A comma-separated list of scroll IDs to clear
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -185,6 +189,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-count.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -242,6 +248,8 @@ Options:::
|
||||
`String` -- The type of the document being count percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -315,6 +323,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -377,6 +387,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-delete.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -412,6 +424,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -445,6 +459,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -496,6 +512,8 @@ client.exists({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document (use `_all` to fetch the first document matching the ID across all types)
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -586,6 +604,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-explain.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -629,6 +649,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-field-stats.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -898,6 +920,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-index_.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -983,6 +1007,8 @@ client.mget({
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1020,6 +1046,8 @@ Options:::
|
||||
`String` -- The index of the document being count percolated to use as default
|
||||
`type`::
|
||||
`String` -- The type of the document being percolated to use as default.
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1070,6 +1098,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to use as default
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to use as default
|
||||
`body`::
|
||||
`Object[], JSONLines` -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-multi-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1127,6 +1157,8 @@ Options:::
|
||||
`String` -- The index in which the document resides.
|
||||
`type`::
|
||||
`String` -- The type of the document.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1266,6 +1298,8 @@ Options:::
|
||||
`String` -- The type of the document being percolated.
|
||||
`id`::
|
||||
`String` -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-percolate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1323,6 +1357,8 @@ Options:::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-scripting.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1362,6 +1398,8 @@ Options:::
|
||||
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1398,6 +1436,8 @@ Options:::
|
||||
`Boolean` -- Should the request should block until the reindex is complete.
|
||||
`requestsPerSecond`::
|
||||
`Number` -- The throttle for this request in sub-requests per second. 0 means set no throttle.
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-reindex.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1423,6 +1463,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Number` -- The throttle to set on this request in sub-requests per second. 0 means set no throttle. As does "unlimited". Otherwise it must be a float.
|
||||
`taskId`::
|
||||
`String` -- The task id to rethrottle
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-reindex.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1446,6 +1488,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- The id of the stored search template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/2.4/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1501,6 +1545,8 @@ client.search({
|
||||
`DurationString` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`scrollId`::
|
||||
`String` -- The scroll ID
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1650,6 +1696,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-search.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1711,6 +1759,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to restrict the results
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of types to restrict the results
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1754,6 +1804,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-shards.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1807,6 +1859,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1879,6 +1933,8 @@ Options:::
|
||||
`String` -- Specific routing value
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-suggesters.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -1938,6 +1994,8 @@ Options:::
|
||||
`String` -- The type of the document.
|
||||
`id`::
|
||||
`String` -- The id of the document, when not specified a doc param should be supplied.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2075,6 +2133,8 @@ Options:::
|
||||
`String` -- The name of the index
|
||||
`type`::
|
||||
`String` -- The type of the document
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-update.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2210,6 +2270,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to search; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/docs-update-by-query.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2938,6 +3000,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -2969,6 +3033,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout for connection to master node
|
||||
`timeout`::
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3092,6 +3158,8 @@ Options:::
|
||||
* `"detailed"`
|
||||
* `"text"`
|
||||
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-analyze.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3139,6 +3207,8 @@ Options:::
|
||||
`Boolean` -- Clear the recycler cache
|
||||
`request`::
|
||||
`Boolean` -- Clear request cache
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3179,6 +3249,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma separated list of indices to close
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3208,6 +3280,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Whether to update the mapping for all fields with the same name across all types or not
|
||||
`index`::
|
||||
`String` -- The name of the index
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-create-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3235,6 +3309,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3264,6 +3340,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3291,6 +3369,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3318,6 +3398,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3355,6 +3437,8 @@ Options:::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of indices to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3394,6 +3478,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to filter aliases
|
||||
`name`::
|
||||
`String, String[], Boolean` -- A comma-separated list of alias names to return
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3421,6 +3507,8 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3460,6 +3548,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` to check the types across all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to check
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3499,6 +3589,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3534,6 +3626,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3579,6 +3673,8 @@ Options:::
|
||||
`Boolean` -- Specify whether the request should block until the merge process is finished (default: true)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -3961,6 +4057,8 @@ Options:::
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma separated list of indices to open
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-open-close.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4006,6 +4104,8 @@ Options:::
|
||||
`Boolean` -- Specify whether the request should block until the merge process is finished (default: true)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-optimize.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4035,6 +4135,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
|
||||
`name`::
|
||||
`String` -- The name of the alias to be created or updated
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4078,6 +4180,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4117,6 +4221,8 @@ Options:::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4150,6 +4256,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`name`::
|
||||
`String` -- The name of the template
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-templates.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4193,6 +4301,8 @@ Options:::
|
||||
`String` -- The name of the warmer
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-warmers.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4261,6 +4371,8 @@ Options:::
|
||||
`Anything` -- TODO: ?
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-refresh.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4423,6 +4535,8 @@ client.indices.updateAliases({
|
||||
`DurationString` -- Request timeout
|
||||
`masterTimeout`::
|
||||
`DurationString` -- Specify timeout for connection to master
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-aliases.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4462,6 +4576,8 @@ Options:::
|
||||
`Boolean` -- If true, only ancient (an older Lucene major release) segments will be upgraded
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4523,6 +4639,8 @@ Options:::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String, String[], Boolean` -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/search-validate.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4671,6 +4789,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4700,6 +4820,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`Boolean` -- Whether to verify the repository after creation
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4727,6 +4849,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4754,6 +4878,8 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String, String[], Boolean` -- A comma-separated list of repository names
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4837,6 +4963,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- A repository name
|
||||
`snapshot`::
|
||||
`String` -- A snapshot name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4891,6 +5019,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`DurationString` -- Explicit operation timeout
|
||||
`repository`::
|
||||
`String` -- A repository name
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
@ -4922,6 +5052,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
`String` -- Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.
|
||||
`taskId`::
|
||||
`String` -- Cancel the task with specified id
|
||||
`body`::
|
||||
`Object, JSON` -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/2.4/tasks.html#_task_cancellation[the elasticsearch docs] for details about what can be specified here.
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
|
||||
Reference in New Issue
Block a user