Run a retention policy Generally available; Added in 7.5.0

POST /_slm/_execute_retention
Api key auth Basic auth Bearer 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

    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.

    Values are -1 or 0.

  • timeout string

    The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

    Values are -1 or 0.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • acknowledged boolean Required

      For a successful response, this value is always true. On failure, an exception is returned instead.
POST /_slm/_execute_retention 
POST _slm/_execute_retention 
resp = client.slm.execute_retention()
const response = await client.slm.executeRetention();
response = client.slm.execute_retention
$resp = $client->slm()->executeRetention();
curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_slm/_execute_retention"