Start snapshot lifecycle management

POST /_slm/start

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

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Query parameters

Response

application/json

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
}