1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859 |
- [role="xpack"]
- [[ilm-retry-policy]]
- === Retry policy execution API
- ++++
- <titleabbrev>Retry policy</titleabbrev>
- ++++
- Retry executing the policy for an index that is in the ERROR step.
- [[ilm-retry-policy-request]]
- ==== {api-request-title}
- `POST <index>/_ilm/retry`
- [[ilm-retry-policy-prereqs]]
- ==== {api-prereq-title}
- * If the {es} {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>>.
- [[ilm-retry-policy-desc]]
- ==== {api-description-title}
- Sets the policy back to the step where the error occurred and executes the step.
- Use the <<ilm-explain-lifecycle, {ilm-init} Explain API>> to determine if an index is in the ERROR
- step.
- [[ilm-retry-policy-path-params]]
- ==== {api-path-parms-title}
- `<index>`::
- (Required, string) Identifier for the indices to retry in comma-separated format.
- [[ilm-retry-policy-query-params]]
- ==== {api-query-parms-title}
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
- [[ilm-retry-policy-example]]
- ==== {api-examples-title}
- The following example retries the policy for `my-index-000001`.
- [source,js]
- --------------------------------------------------
- POST my-index-000001/_ilm/retry
- --------------------------------------------------
- // NOTCONSOLE
- If the request succeeds, you receive the following result:
- [source,js]
- --------------------------------------------------
- {
- "acknowledged": true
- }
- --------------------------------------------------
- // NOTCONSOLE
|