Run a retention policy

  • POST /_slm/_execute_retention
Auth

Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. The retention policy is normally applied according to its schedule.

Required authorization

Cluster privileges manage_slm

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
acknowledged boolean required

For a successful response, this value is always true. On failure, an exception is returned instead.