IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Searchable snapshots APIs Security APIs »
Elastic Docs ›Elasticsearch Guide [7.12] ›REST APIs ›Searchable snapshots APIs

Mount snapshot API

edit

Mount snapshot API

edit

Mount a snapshot as a searchable snapshot index.

Request

edit

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

Prerequisites

edit

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.

Description

edit

Path parameters

edit
<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 parameters

edit
master_timeout
(Optional, time units) Period 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 false.
storage

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

(Optional, string) Selects the kind of local storage used to accelerate searches of the mounted index. If full_copy, each node holding a shard of the searchable snapshot index makes a full copy of the shard to its local storage. If shared_cache, the shard uses the shared cache. Defaults to full_copy. See Mount options.

Request body

edit
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.

Examples

edit

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
  },
  "ignore_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 index settings to ignore when mounting the snapshotted index
« Searchable snapshots APIs Security APIs »