IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Snapshot lifecycle management APIs Get snapshot lifecycle policy API »
Elastic Docs ›Elasticsearch Guide [7.11] ›REST APIs ›Snapshot lifecycle management APIs

Create or update snapshot lifecycle policy API

edit

Create or update snapshot lifecycle policy API

edit

Creates or updates a snapshot lifecycle policy.

Request

edit

PUT /_slm/policy/<snapshot-lifecycle-policy-id>

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the manage_slm cluster privilege and the manage index privilege for any included indices to use this API. For more information, see Security privileges.

Description

edit

Use the create or update snapshot lifecycle policy API to create or update a snapshot lifecycle policy.

If the policy already exists, this request increments the policy’s version. Only the latest version of a policy is stored.

Path parameters

edit
<snapshot-lifecycle-policy-id>
(Required, string) ID for the snapshot lifecycle policy you want to create or update.

Query parameters

edit
master_timeout
(Optional, time units) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
timeout
(Optional, time units) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

Request body

edit
config

(Required, object) Configuration for each snapshot created by the policy.

Properties of config
ignore_unavailable
(Optional, Boolean) If true, missing data streams or indices do not cause snapshot creation to fail and return an error. Defaults to false.
include_global_state
(Optional, Boolean) If true, cluster states are included in snapshots. Defaults to false.
indices
(Optional, array of strings) Array of data streams and indices to include in snapshots. Date math and wildcard (*) expressions are supported.
name
(Required, string) Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name.
repository
(Required, string) Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API.
retention

(Optional, object) Retention rules used to retain and delete snapshots created by the policy.

Properties of retention
expire_after
(Optional, time units) Time period after which a snapshot is considered expired and eligible for deletion.
max_count

(Optional, integer) Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots.

The maximum number of snapshots in a repository should not exceed 200. This ensures that the snapshot repository metadata does not grow to a size which might destabilize the master node. If the max_count setting is not set, this limit should be enforced by configuring other retention rules such that the repository size does not exceed 200 snapshots.

min_count
(Optional, integer) Minimum number of snapshots to retain, even if the snapshots have expired.
schedule
(Required, Cron syntax) Periodic or absolute schedule at which the policy creates snapshots and deletes expired snapshots. Schedule changes to existing policies are applied immediately.

Examples

edit

Create a daily-snapshots lifecycle policy:

PUT /_slm/policy/daily-snapshots
{
  "schedule": "0 30 1 * * ?", 
  "name": "<daily-snap-{now/d}>", 
  "repository": "my_repository", 
  "config": { 
    "indices": ["data-*", "important"], 
    "ignore_unavailable": false,
    "include_global_state": false
  },
  "retention": { 
    "expire_after": "30d", 
    "min_count": 5, 
    "max_count": 50 
  }
}

When the snapshot should be taken, in this case, 1:30am daily

The name each snapshot should be given

Which repository to take the snapshot in

Any extra snapshot configuration

Data streams and indices the snapshot should contain

Optional retention configuration

Keep snapshots for 30 days

Always keep at least 5 successful snapshots, even if they’re more than 30 days old

Keep no more than 50 successful snapshots, even if they’re less than 30 days old
« Snapshot lifecycle management APIs Get snapshot lifecycle policy API »