restore_snapshot

Restore Elasticsearch indices from specific snapshots with options for index selection, conflict resolution, and custom settings. Ideal for recovering data from designated repositories efficiently.

Instructions

Restore indices from an Elasticsearch snapshot with comprehensive options and conflict resolution

Input Schema

Name	Required	Description	Default
`ignore_unavailable`	No	Whether to ignore unavailable indices
`include_global_state`	No	Whether to restore cluster global state
`index_settings`	No	JSON string of index settings to override
`indices`	No	Comma-separated list of indices to restore (default: all from snapshot)
`rename_pattern`	No	Pattern to rename restored indices (e.g., 'restored_%s')
`repository`	No	Repository containing the snapshot	backup_repository
`snapshot_name`	Yes	Name of the snapshot to restore from
`wait_for_completion`	No	Whether to wait for restore completion

Input Schema (JSON Schema)

{
  "properties": {
    "ignore_unavailable": {
      "default": true,
      "description": "Whether to ignore unavailable indices",
      "title": "Ignore Unavailable",
      "type": "boolean"
    },
    "include_global_state": {
      "default": false,
      "description": "Whether to restore cluster global state",
      "title": "Include Global State",
      "type": "boolean"
    },
    "index_settings": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "JSON string of index settings to override",
      "title": "Index Settings"
    },
    "indices": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Comma-separated list of indices to restore (default: all from snapshot)",
      "title": "Indices"
    },
    "rename_pattern": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Pattern to rename restored indices (e.g., 'restored_%s')",
      "title": "Rename Pattern"
    },
    "repository": {
      "default": "backup_repository",
      "description": "Repository containing the snapshot",
      "title": "Repository",
      "type": "string"
    },
    "snapshot_name": {
      "description": "Name of the snapshot to restore from",
      "title": "Snapshot Name",
      "type": "string"
    },
    "wait_for_completion": {
      "default": true,
      "description": "Whether to wait for restore completion",
      "title": "Wait For Completion",
      "type": "boolean"
    }
  },
  "required": [
    "snapshot_name"
  ],
  "type": "object"
}

Agent Knowledge MCP

restore_snapshot

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from Agent Knowledge MCP

Related Tools

MCP directory API