Start snapshot lifecycle management

POST /_slm/start

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 · default: 30s: 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.
timeout string · default: 30s: 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.

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _slm/start

JavaScript Elasticsearch JavaScript Client

const response = await client.slm.start();

Python Elasticsearch Python Client

resp = client.slm.start()

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_slm/start" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.slm().start(s -> s);

C# Elasticsearch .NET Client

var response = await client.SnapshotLifecycleManagement.StartAsync();

PHP Elasticsearch PHP Client

$resp = $client->slm()->start();

Ruby Elasticsearch Ruby Client

response = client.slm.start

Response

A successful response from POST _slm/start.

{
  "acknowledged": true
}