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

[api] regenerate

Browse Source
This commit is contained in:
spalger
2016-11-16 13:01:34 -07:00
parent 849c28a8d0
commit 45faa4ad91
15 changed files with 1812 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
docs/api_methods_2_2.asciidoc
View File

@ -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]