This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Stop index lifecycle management API
editStop index lifecycle management API
editStop the index lifecycle management (ILM) plugin.
Request
editPOST /_ilm/stop
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
editHalts all lifecycle management operations and stops the ILM plugin. This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices.
The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. Use the Get ILM Status API to see if ILM is running.
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 stops the ILM plugin.
resp = client.ilm.stop() print(resp)
response = client.ilm.stop puts response
const response = await client.ilm.stop(); console.log(response);
POST _ilm/stop
If the request does not encounter errors, you receive the following result:
{
"acknowledged": true
}