create_snapshot
Generate a snapshot of Elasticsearch indices with customizable options, including repository selection, index inclusion, and global state management, for comprehensive backup and recovery.
Instructions
Create a snapshot (backup) of Elasticsearch indices with comprehensive options and repository management
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| description | No | Optional description for the snapshot | |
| ignore_unavailable | No | Whether to ignore unavailable indices | |
| include_global_state | No | Whether to include cluster global state | |
| indices | No | Comma-separated list of indices to backup (default: all indices) | |
| repository | No | Repository name to store the snapshot | backup_repository |
| snapshot_name | Yes | Name for the snapshot (must be unique) | |
| wait_for_completion | No | Whether to wait for snapshot completion |
Input Schema (JSON Schema)
{
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional description for the snapshot",
"title": "Description"
},
"ignore_unavailable": {
"default": true,
"description": "Whether to ignore unavailable indices",
"title": "Ignore Unavailable",
"type": "boolean"
},
"include_global_state": {
"default": true,
"description": "Whether to include cluster global state",
"title": "Include Global State",
"type": "boolean"
},
"indices": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Comma-separated list of indices to backup (default: all indices)",
"title": "Indices"
},
"repository": {
"default": "backup_repository",
"description": "Repository name to store the snapshot",
"title": "Repository",
"type": "string"
},
"snapshot_name": {
"description": "Name for the snapshot (must be unique)",
"title": "Snapshot Name",
"type": "string"
},
"wait_for_completion": {
"default": true,
"description": "Whether to wait for snapshot completion",
"title": "Wait For Completion",
"type": "boolean"
}
},
"required": [
"snapshot_name"
],
"type": "object"
}