Mount snapshot APIedit

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.

Requestedit

POST /_snapshot/<repository>/<snapshot>/_mount

Prerequisitesedit

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.

Descriptionedit

Path parametersedit

<repository>
(Required, string) The name of the repository containing the snapshot of the index to mount.
<snapshot>
(Required, string) The name of the snapshot of the index to mount.

Query parametersedit

master_timeout
(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 30s.
wait_for_completion
(Optional, Boolean) If true, the request blocks until the operation is complete. Defaults to true.

Request bodyedit

index
(Required, string) Name of the index contained in the snapshot whose data is to be mounted.

If no renamed_index is specified this name will also be used to create the new index.

renamed_index

(Optional, string) Name of the index that will be created.

index_settings

(Optional, object) Settings that should be added to the index when it is mounted.

ignore_index_settings

(Optional, array of strings) Names of settings that should be removed from the index when it is mounted.

Examplesedit

Mounts the index my_docs from an existing snapshot named my_snapshot stored in the my_repository as a new index docs:

POST /_snapshot/my_repository/my_snapshot/_mount?wait_for_completion=true
{
  "index": "my_docs", 
  "renamed_index": "docs", 
  "index_settings": { 
    "index.number_of_replicas": 0
  },
  "ignored_index_settings": [ "index.refresh_interval" ] 
}

The name of the index in the snapshot to mount

The name of the index to create

Any index settings to add to the new index

List of indices to ignore when mounting the snapshotted index