Mount a snapshot

POST /_snapshot/{repository}/{snapshot}/_mount

Auth

Mount a snapshot as a searchable snapshot index. Do not use this API for snapshots managed by index lifecycle management (ILM). Manually mounting ILM-managed snapshots can interfere with ILM processes.

Required privileges

Index privileges manage
Cluster privileges manage

Path parameters

repository string required: The name of the repository containing the snapshot of the index to mount.
snapshot string required: The name of the snapshot of the index to mount.

Query parameters

master_timeout union oneOf · default: 30s

The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

Values: -1 0

wait_for_completion boolean · default: false

If true, the request blocks until the operation is complete.

storage enum · default: full_copy

The mount option for the searchable snapshot index. For further information on mount options, refer to: Mount options

Supported values include:

full_copy: Fully caches the snapshotted index’s shards in the Elasticsearch cluster.
shared_cache: Uses a local cache containing only recently searched parts of the snapshotted index’s data.

Values: full_copy shared_cache

Request body

index string required: The 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 string: The name of the index that will be created.
index_settings map string to object: The settings that should be added to the index when it is mounted.
ignore_index_settings string[]: The names of settings that should be removed from the index when it is mounted.

Response

application/json

snapshot object required

View as Markdown

Examples

Request Console 1 / 8 languages

Run POST /_snapshot/my_repository/my_snapshot/_mount?wait_for_completion=true to mount the index my_docs from an existing snapshot named my_snapshot stored in my_repository as a new index docs.

Console Kibana Dev Tools

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" ]
}

JavaScript Elasticsearch JavaScript Client

const response = await client.searchableSnapshots.mount({
  repository: "my_repository",
  snapshot: "my_snapshot",
  wait_for_completion: "true",
  index: "my_docs",
  renamed_index: "docs",
  index_settings: {
    "index.number_of_replicas": 0,
  },
  ignore_index_settings: ["index.refresh_interval"],
});

Python Elasticsearch Python Client

resp = client.searchable_snapshots.mount(
    repository="my_repository",
    snapshot="my_snapshot",
    wait_for_completion=True,
    index="my_docs",
    renamed_index="docs",
    index_settings={
        "index.number_of_replicas": 0
    },
    ignore_index_settings=[
        "index.refresh_interval"
    ],
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_snapshot/my_repository/my_snapshot/_mount?wait_for_completion=true" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "index": "my_docs",
    "renamed_index": "docs",
    "index_settings": {
      "index.number_of_replicas": 0
    },
    "ignore_index_settings": [
      "index.refresh_interval"
    ]
  }'

Java Elasticsearch Java Client

client.searchableSnapshots().mount(m -> m
    .ignoreIndexSettings("index.refresh_interval")
    .index("my_docs")
    .indexSettings("index.number_of_replicas", JsonData.fromJson("0"))
    .renamedIndex("docs")
    .repository("my_repository")
    .snapshot("my_snapshot")
    .waitForCompletion(true)
);

C# Elasticsearch .NET Client

var response = await client.SearchableSnapshots
    .MountAsync(repository: "my_repository", snapshot: "my_snapshot", d1 => d1
        .WaitForCompletion(true)
        .IgnoreIndexSettings("index.refresh_interval")
        .Index("my_docs")
        .IndexSettings(new Dictionary<string, object>()
        {
            { "index.number_of_replicas", 0 }
        })
        .RenamedIndex("docs")
    );

PHP Elasticsearch PHP Client

$resp = $client->searchableSnapshots()->mount([
    "repository" => "my_repository",
    "snapshot" => "my_snapshot",
    "wait_for_completion" => "true",
    "body" => [
        "index" => "my_docs",
        "renamed_index" => "docs",
        "index_settings" => [
            "index.number_of_replicas" => 0,
        ],
        "ignore_index_settings" => array(
            "index.refresh_interval",
        ),
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.searchable_snapshots.mount(
  repository: "my_repository",
  snapshot: "my_snapshot",
  wait_for_completion: "true",
  body: {
    "index": "my_docs",
    "renamed_index": "docs",
    "index_settings": {
      "index.number_of_replicas": 0
    },
    "ignore_index_settings": [
      "index.refresh_interval"
    ]
  }
)

Response

{
  "snapshot": {
    "snapshot": "string",
    "indices": "string",
    "shards": {
      "failed": 0,
      "successful": 0,
      "total": 0,
      "failures": [
        {
          "index": "string",
          "node": "string",
          "reason": {
            "type": "string",
            "stack_trace": "string"
          },
          "shard": 0,
          "status": "string",
          "primary": false
        }
      ],
      "skipped": 0
    }
  }
}

Generated from the API spec