mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 04:58:50 +00:00
c0156cbb5d
* [DOCS] Align with ILM API docs (#48705) * [DOCS] Reconciled with Snapshot/Restore reorg * [DOCS] Split off ILM overview to a separate topic. (#51287) * [DOCS} Split off overview to a separate topic. * [DOCS] Incorporated feedback from @jrodewig. * [DOCS] Edit ILM GS tutorial (#51513) * [DOCS] Edit ILM GS tutorial * [DOCS] Incorporated review feedback from @andreidan. * [DOCS] Removed test link & fixed anchor & title. * Update docs/reference/ilm/getting-started-ilm.asciidoc Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Fixed glossary merge error. Co-authored-by: James Rodewig <james.rodewig@elastic.co>
37 lines
1.0 KiB
Plaintext
37 lines
1.0 KiB
Plaintext
[[slm-api-execute-retention]]
|
|
=== Execute snapshot retention policy API
|
|
++++
|
|
<titleabbrev>Execute snapshot retention policy</titleabbrev>
|
|
++++
|
|
|
|
Deletes any snapshots that are expired according to the policy's retention rules.
|
|
|
|
[[slm-api-execute-retention-request]]
|
|
==== {api-request-title}
|
|
|
|
`POST /_slm/_execute_retention`
|
|
|
|
[[slm-api-execute-retention-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
If the {es} {security-features} are enabled, you must have the `manage_slm`
|
|
cluster privilege to use this API. For more information, see
|
|
<<security-privileges>>.
|
|
|
|
[[slm-api-execute-retention-desc]]
|
|
==== {api-description-title}
|
|
|
|
Manually applies the retention policy to force immediate removal of expired snapshots.
|
|
The retention policy is normally applied according to its schedule.
|
|
|
|
[[slm-api-execute-retention-example]]
|
|
==== {api-examples-title}
|
|
|
|
To force removal of expired snapshots:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST /_slm/_execute_retention
|
|
--------------------------------------------------
|
|
|
|
Retention runs asynchronously in the background. |