IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Stop index lifecycle management API
editStop index lifecycle management API
editStop the index lifecycle management (ILM) plugin.
Request
editPOST /_ilm/stop
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.
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 stops the ILM plugin.
POST _ilm/stop
If the request does not encounter errors, you receive the following result:
{
"acknowledged": true
}