Retry policy execution API

Retry executing the 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_ilm privileges 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

timeout
(Optional, 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.
master_timeout
(Optional, 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.

Examples

The following example retries the policy for my_index.

POST my_index/_ilm/retry

If the request succeeds, you receive the following result:

{
  "acknowledged": true
}