Docs
Elasticsearch Guide [8.1] » REST APIs » Snapshot lifecycle management APIs » Start snapshot lifecycle management API
« Get snapshot lifecycle stats API Stop snapshot lifecycle management API »

Start snapshot lifecycle management API

Turns on snapshot lifecycle management (SLM).

Request

POST /_slm/start

Prerequisites

If the Elasticsearch security features are enabled, you must have the manage_slm cluster privilege to use this API. For more information, see Security privileges.

Description

Starts the SLM plugin if it’s not running. SLM starts automatically when a cluster is formed. Manually starting SLM is only necessary if it has been stopped using the Stop snapshot lifecycle management.

Query parameters

master_timeout
(Optional, time units) 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. Defaults to 30s.
timeout
(Optional, time units) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

Examples

Start the SLM plugin:

POST _slm/start

If successful, this request returns:

{
  "acknowledged": true
}
« Get snapshot lifecycle stats API Stop snapshot lifecycle management API »