Start Snapshot Lifecycle Management API

Start the Snapshot Lifecycle Management (SLM) plugin.

Request

POST /_slm/start

Description

Starts the SLM plugin if it is currently stopped. SLM is started automatically when the cluster is formed. Restarting SLM is only necessary if it has been stopped using the Stop SLM API.

Request Parameters

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

Authorization

You must have the manage_slm cluster privilege to use this API. For more information, see Security privileges.

Examples

Starts the SLM plugin.

POST _slm/start

If the request succeeds, you receive the following result:

{
  "acknowledged": true
}