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

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

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

      Additional properties are allowed.

  • 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

      Additional properties are allowed.

      Hide snapshot attributes Show snapshot attributes object
POST /_snapshot/{repository}/{snapshot}/_mount
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"]}'
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
    }
  }
}