Get policy information

Auth

Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.

Required authorization

Cluster privileges manage_slm

Path parameters

policy_id union string | string[] optional

A comma-separated list of snapshot lifecycle policy identifiers.

Leave it out to use /_slm/policy.

Query parameters

master_timeout string · default: 30s

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

timeout string · default: 30s

The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Response

application/json
<string> object
in_progress object
name string required
start_time_millis number required
state string required
uuid string required
last_failure object
snapshot_name string required
time union oneOf required
One of: string or number
last_success object
snapshot_name string required
time union oneOf required
One of: string or number
modified_date union oneOf

The last time the policy was modified.

One of: string or number
modified_date_millis number required
next_execution union oneOf

The next time the policy will run.

One of: string or number
next_execution_millis number required
policy object required
config object
ignore_unavailable boolean · default: false

If false, the snapshot fails if any data stream or index in indices is missing or closed. If true, the snapshot ignores missing or closed data streams and indices.

indices union oneOf

A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported. By default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters.

One of: string[] or string
include_global_state boolean · default: true

If true, the current global state is included in the snapshot.

feature_states string[]

A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API. Each feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false.

metadata object

Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes.

partial boolean · default: false

If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available.

name string required
repository string required
retention object
expire_after string required

Time period after which a snapshot is considered expired and eligible for deletion. SLM deletes expired snapshots based on the slm.retention_schedule.

max_count number required

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.

min_count number required

Minimum number of snapshots to retain, even if the snapshots have expired.

schedule string required
version number required

The version of the snapshot policy. Only the latest version is stored and incremented when the policy is updated.

stats object required
retention_deletion_time string
retention_deletion_time_millis number
retention_failed number
retention_runs number
retention_timed_out number
policy string
total_snapshots_deleted number
total_snapshot_deletion_failures number
total_snapshots_failed number
total_snapshots_taken number