Start index lifecycle management APIedit

Start the index lifecycle management (ILM) plugin.

Requestedit

POST /_ilm/start

Prerequisitesedit

  • If the Elasticsearch security features are enabled, you must have the manage_ilm cluster privilege to use this API. For more information, see Security privileges.

Descriptionedit

Starts the ILM plugin if it is currently stopped. ILM is started automatically when the cluster is formed. Restarting ILM is only necessary if it has been stopped using the Stop ILM API.

Query parametersedit

master_timeout
(Optional, time units) 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. Defaults to 30s.
timeout
(Optional, time units) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

Examplesedit

The following example starts the ILM plugin.

POST _ilm/start

If the request succeeds, you receive the following result:

{
  "acknowledged": true
}