Stop index lifecycle management API
Stop the index lifecycle management (ILM) plugin.
Request
POST /_ilm/stop
Prerequisites
- 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
Halts 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
-
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.
Examples
The following example stops the ILM plugin.
POST _ilm/stop
If the request does not encounter errors, you receive the following result:
{
"acknowledged": true
}
© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/ilm-stop.html
