Skip to content

Update sm-api.md to include snapshot pattern deletion feature #11131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 29, 2025
Merged

Update sm-api.md to include snapshot pattern deletion feature #11131

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db691e2
Update sm-api.md to include snapshot pattern deletion feature
Tarun-kishore Sep 29, 2025
fbc0831
Update _tuning-your-cluster/availability-and-recovery/snapshots/sm-ap…
kolchfa-aws Sep 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions _tuning-your-cluster/availability-and-recovery/snapshots/sm-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@ POST _plugins/_sm/policies/daily-policy
"max_count": 21,
"min_count": 7
},
"time_limit": "1h"
"time_limit": "1h",
"snapshot_pattern": "external-backup-*"
},
"snapshot_config": {
"date_format": "yyyy-MM-dd-HH:mm",
Expand Down Expand Up @@ -132,7 +133,8 @@ POST _plugins/_sm/policies/daily-policy
"min_count" : 7,
"max_count" : 21
},
"time_limit" : "1h"
"time_limit" : "1h",
"snapshot_pattern" : "external-backup-*"
},
"snapshot_config" : {
"indices" : "*",
Expand Down Expand Up @@ -188,7 +190,7 @@ Parameter | Type | Description
`snapshot_config.include_global_state` | Boolean | Do you want to include cluster state? Optional. Default is `true` because of [Security plugin considerations]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore#security-considerations).
`snapshot_config.partial` | Boolean | Do you want to allow partial snapshots? Optional. Default is `false`.
`snapshot_config.metadata` | Object | Metadata in the form of key/value pairs. Optional.
`creation` | Object | Configuration for snapshot creation. Required.
`creation` | Object | Configuration for snapshot creation. Optional. (This parameter is optional only for OpenSearch 3.3 and later; it should not be left unset until all nodes are upgraded to 3.3 or later.)
`creation.schedule` | String | The cron schedule used to create snapshots. Required.
`creation.time_limit` | String | Sets the maximum time to wait for snapshot creation to finish. If time_limit is longer than the scheduled time interval for taking snapshots, no scheduled snapshots are taken until time_limit elapses. For example, if time_limit is set to 35 minutes and snapshots are taken every 30 minutes starting at midnight, the snapshots at 00:00 and 01:00 are taken, but the snapshot at 00:30 is skipped. Optional.
`deletion` | Object | Configuration for snapshot deletion. Optional. Default is to retain all snapshots.
Expand All @@ -198,6 +200,7 @@ Parameter | Type | Description
`deletion.delete_condition.max_count` | Integer | The maximum number of snapshots to be retained. Optional.
`deletion.delete_condition.max_age` | String | The maximum time a snapshot is retained. Optional.
`deletion.delete_condition.min_count` | Integer | The minimum number of snapshots to be retained. Optional. Default is `1`.
`deletion.snapshot_pattern` | String | Additional snapshot patterns to include in deletion. This allows deletion of snapshots that match the specified pattern in addition to the policy's own snapshots. Supports wildcards (`*`). Optional.
`notification` | Object | Defines notifications for SM events. Optional.
`notification.channel` | Object | Defines a channel for notifications. You must [create and configure a notification channel]({{site.url}}{{site.baseurl}}/notifications-plugin/api) before setting up SM notifications. Required.
`notification.channel.id` | String | The channel ID of the channel used for notifications. To get the channel IDs of all created channels, use `GET _plugins/_notifications/configs`. Required.
Expand Down Expand Up @@ -271,7 +274,8 @@ GET _plugins/_sm/policies/daily-policy
"min_count" : 7,
"max_count" : 21
},
"time_limit" : "1h"
"time_limit" : "1h",
"snapshot_pattern" : "external-backup-*"
},
"snapshot_config" : {
"metadata" : {
Expand Down Expand Up @@ -460,4 +464,4 @@ DELETE _plugins/_sm/policies/daily-policy
"_seq_no" : 45366,
"_primary_term" : 20
}
```
```