Mount a snapshot Added in 7.10.0
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.
Path parameters
-
The name of the repository containing the snapshot of the index to mount.
-
The name of the snapshot of the index to mount.
Query parameters
-
master_timeout string
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
. -
wait_for_completion boolean
If true, the request blocks until the operation is complete.
-
storage string
The mount option for the searchable snapshot index.
Body Required
-
renamed_index string
-
index_settings object
The settings that should be added to the index when it is mounted.
-
ignore_index_settings array[string]
The names of settings that should be removed from the index when it is mounted.
curl \
-X POST http://api.example.com/_snapshot/{repository}/{snapshot}/_mount \
-H "Content-Type: application/json" \
-d '{"index":"string","renamed_index":"string","index_settings":{"additionalProperty1":{},"additionalProperty2":{}},"ignore_index_settings":["string"]}'
{
"index": "string",
"renamed_index": "string",
"index_settings": {
"additionalProperty1": {},
"additionalProperty2": {}
},
"ignore_index_settings": [
"string"
]
}
{
"snapshot": {
"snapshot": "string",
"indices": "string",
"shards": {
"failed": 42.0,
"successful": 42.0,
"total": 42.0,
"failures": [
{
"index": "string",
"node": "string",
"reason": {
"type": "string",
"reason": "string",
"stack_trace": "string",
"caused_by": {},
"root_cause": [
{}
],
"suppressed": [
{}
]
},
"shard": 42.0,
"status": "string"
}
],
"skipped": 42.0
}
}
}