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

110
docs/api_methods_1_2.asciidoc
View File

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