Retry policy execution API
Retry executing the lifecycle policy for an index that is in the ERROR step.
Request
POST <index>/_ilm/retry
Prerequisites
- If the Elasticsearch security features are enabled, you must have the
manage_ilmprivileges on the indices being managed to use this API. For more information, see Security privileges.
Description
Sets the policy back to the step where the error occurred and executes the step. Use the ILM Explain API to determine if an index is in the ERROR step.
Path parameters
-
<index> - (Required, string) Identifier for the indices to retry in comma-separated format.
Query parameters
-
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
The following example retries the policy for my-index-000001.
POST my-index-000001/_ilm/retry
If the request succeeds, 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/8.17/ilm-retry-policy.html
