Start the ILM plugin

POST /_ilm/start

Start the index lifecycle management plugin if it is currently stopped. ILM is started automatically when the cluster is formed. Restarting ILM is necessary only when it has been stopped using the stop ILM API.

Required authorization

Cluster privileges: manage_ilm

Query Parameters

Response

application/json

Examples

A successful response when stating the ILM plugin.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _ilm/start

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

resp = client.ilm.start()

curl Shell

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

Java Elasticsearch Java Client

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

C# Elasticsearch .NET Client

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

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

response = client.ilm.start

Response

{
  "acknowledged": true
}

Required authorization

Query Parameters { master_timeout , timeout , }

Response

Query Parameters