NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.
Start index lifecycle management API
editStart index lifecycle management API
editStart the index lifecycle management (ILM) plugin.
Request
editPOST /_ilm/start
Description
editStarts 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
edit-
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
editYou must have the manage_ilm cluster privilege to use this API.
For more information, see Security privileges.
Examples
editThe following example starts the ILM plugin.
POST _ilm/start
If the request succeeds, you receive the following result:
{
"acknowledged": true
}