slm-execute-retention.asciidoc

Execute snapshot retention policy API

Execute snapshot retention policy

New API reference

For the most up-to-date API details, refer to {api-es}/group/endpoint-slm[{slm-cap} APIs].

Deletes any snapshots that are expired according to the policy’s retention rules.

{api-request-title}

POST /_slm/_execute_retention

{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].

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

{api-examples-title}

To force removal of expired snapshots:

POST /_slm/_execute_retention

Retention runs asynchronously in the background.