IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. 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
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
manage_ilmcluster privilege to use this API. For more information, see Security privileges.
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.
Query parameters
edit-
master_timeout -
(Optional, time units)
Period to wait for the master node. If the master node is not available before
the timeout expires, the request fails and returns an error. Defaults to
30s. Can also be set to-1to indicate that the request should never timeout. -
timeout -
(Optional, time units) Period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.
If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.
Defaults to
30s. Can also be set to-1to indicate that the request should never timeout.
Examples
editThe following example starts the ILM plugin.
resp = client.ilm.start() print(resp)
response = client.ilm.start puts response
const response = await client.ilm.start(); console.log(response);
POST _ilm/start
If the request succeeds, you receive the following result:
{
"acknowledged": true
}