IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Execute snapshot lifecycle retention API
editExecute snapshot lifecycle retention API
editDeletes any expired snapshots based on lifecycle policy retention rules.
Request
editPOST /_slm/_execute_retention
Description
editWhile Snapshot Lifecycle Management retention is usually invoked through the global cluster settings for its schedule, it can sometimes be useful to invoke a retention run to expunge expired snapshots immediately. This API allows you to run a one-off retention run.
Examples
editTo immediately start snapshot retention, use the following request:
POST /_slm/_execute_retention
This API returns the following response as retention runs asynchronously in the background:
{
"acknowledged": true
}