This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Mount a snapshot as a searchable snapshot index.
If the Elasticsearch security features are enabled, you must have the
manage cluster privilege and the
manage index privilege
for any included indices to use this API.
For more information, see Security privileges.
- (Required, string) The name of the repository containing the snapshot of the index to mount.
- (Required, string) The name of the snapshot of the index to mount.
(Optional, time units) Specifies the period of time to wait for
a connection to the master node. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to
(Optional, Boolean) If
true, the request blocks until the operation is complete. Defaults to
- (Required, string) Name of the index contained in the snapshot whose data is to be mounted.
renamed_index is specified this name
will also be used to create the new index.
(Optional, string) Name of the index that will be created.
(Optional, object) Settings that should be added to the index when it is mounted.
(Optional, array of strings) Names of settings that should be removed from the index when it is mounted.
Mounts the index
my_docs from an existing snapshot named
my_repository as a new index