Start snapshot lifecycle management Generally available; Added in 7.6.0

View as markdown
POST /_slm/start
Api key auth Basic auth Bearer auth

Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. Manually starting SLM is necessary only if it has been stopped using the stop SLM API.

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. To indicate that the request should never timeout, set it to -1.

    External documentation
  • 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. To indicate that the request should never timeout, set it to -1.

    External documentation

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/start 
POST _slm/start

resp = client.slm.start()
const response = await client.slm.start();
response = client.slm.start
$resp = $client->slm()->start();
curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_slm/start"
client.slm().start(s -> s);
Response examples (200)
A successful response from `POST _slm/start`. 
{
  "acknowledged": true
}