Mount a snapshot | Elasticsearch API documentation (v8)

Mount a snapshot Added in 7.10.0

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

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

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

application/json

Body Required

index string Required
renamed_index string
index_settings object

The settings that should be added to the index when it is mounted.
Hide index_settings attribute Show index_settings attribute object
- * object Additional properties
ignore_index_settings array[string]

The names of settings that should be removed from the index when it is mounted.

Responses

200 application/json
Hide response attribute Show response attribute object
- snapshot object Required
  
  Hide snapshot attributes Show snapshot attributes object
  
  snapshot string Required
  
  indices string | array[string] Required
  
  shards object Required
  
  Hide shards attributes Show shards attributes object
  
  failed number Required
  
  successful number Required
  
  total number Required
  
  failures array[object]
  
  Hide failures attributes Show failures attributes object
  
  index string
  
  node string
  
  reason object Required
  
  Hide reason attributes Show reason attributes object
  
  type string Required
  
  The type of error
  
  reason string
  
  A human-readable explanation of the error, in English.
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  root_cause array[object]
  
  suppressed array[object]
  
  shard number Required
  
  status string
  
  skipped number

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

curl \
 --request POST http://api.example.com/_snapshot/{repository}/{snapshot}/_mount \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"index":"string","renamed_index":"string","index_settings":{"additionalProperty1":{},"additionalProperty2":{}},"ignore_index_settings":["string"]}'

Request examples

{
  "index": "string",
  "renamed_index": "string",
  "index_settings": {
    "additionalProperty1": {},
    "additionalProperty2": {}
  },
  "ignore_index_settings": [
    "string"
  ]
}

Response examples (200)

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