Start the ILM plugin

POST /_ilm/start

Auth

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

master_timeout string · default: 30s: 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.
timeout string · default: 30s: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

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 _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

A successful response when stating the ILM plugin.

{
  "acknowledged": true
}