New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Get snapshot lifecycle stats API Stop snapshot lifecycle management API »
Elastic Docs ›Elasticsearch Guide [7.16] ›REST APIs ›Snapshot lifecycle management APIs

Start snapshot lifecycle management API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Start snapshot lifecycle management API

edit

Turns on snapshot lifecycle management (SLM).

Request

edit

POST /_slm/start

Prerequisites

edit

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

edit

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

edit
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

edit

Start the SLM plugin:

POST _slm/start
Copy as curlTry in Elastic 

If successful, this request returns:

{
  "acknowledged": true
}
« Get snapshot lifecycle stats API Stop snapshot lifecycle management API »
Was this helpful?
Feedback