Docs
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elasticsearch Reference [7.1] » X-Pack APIs » Index lifecycle management API » Start index lifecycle management API
« Explain lifecycle API Stop index lifecycle management API »

Start index lifecycle management API

Start the index lifecycle management (ILM) plugin.

Request

POST /_ilm/start

Description

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.

Request Parameters

timeout
(time units) Specifies the period of time to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. For more information about time units, see Time units.
master_timeout
(time units) Specifies the period of time 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. For more information about time units, see Time units.

Authorization

You must have the manage_ilm cluster privilege to use this API. For more information, see Security privileges.

Examples

The following example starts the ILM plugin.

POST _ilm/start

If the request succeeds, you receive the following result:

{
  "acknowledged": true
}
« Explain lifecycle API Stop index lifecycle management API »