Snapshot and restore settings

The following cluster settings configure snapshot and restore and snapshot lifecycle management (SLM).

Tip

This page covers general snapshot and restore settings. For client connection and per-repository settings specific to each repository type, refer to:

snapshot.max_concurrent_operations

(Dynamic, integer) Maximum number of concurrent snapshot operations. Defaults to 1000.

This limit applies in total to all ongoing snapshot creation, cloning, and deletion operations. Elasticsearch will reject any operations that would exceed this limit.

repositories.default_repository The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 9.4 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

(Dynamic, string) A default repository to be used for snapshot and restore operations. Currently, this is only used for DLM Frozen Tier transitions but may be used by other features in the future. By default, this setting is unset, in which case DLM frozen tier transitions will not occur.

The repository must already be registered before it can be set as the default, and a read-only repository cannot be set as the default. A repository that is currently configured as the default cannot be deleted or marked as read-only until you change the setting to a different repository or set it to an empty string.

SLM settings

The following cluster settings configure snapshot lifecycle management (SLM).

slm.history_index_enabled: (Dynamic, Boolean) Controls whether SLM records the history of actions taken as part of SLM policies to the slm-history-* indices. Defaults to true.

slm.retention_schedule: (Dynamic, cron scheduler value) Controls when the retention task runs. Can be a periodic or absolute time schedule. Supports all values supported by the cron scheduler. Defaults to daily at 1:30am UTC: 0 30 1 * * ?.

slm.retention_duration: (Dynamic, time value) Limits how long SLM should spend deleting old snapshots. Defaults to one hour: 1h.

slm.health.failed_snapshot_warn_threshold: (Dynamic, Long) The number of failed invocations since last successful snapshot that indicate a problem with the policy in the health api. Defaults to a health api warning after five repeated failures: 5L.