Retry a policy

POST /{index}/_ilm/retry

Auth

Retry running the lifecycle policy for an index that is in the ERROR step. The API sets the policy back to the step where the error occurred and runs the step. Use the explain lifecycle state API to determine whether an index is in the ERROR step.

Required privileges

Index privileges manage_ilm

Path parameters

index string required: The name of the indices (comma-separated) whose failed lifecycle step is to be retry

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /my-index-000001/_ilm/retry

JavaScript Elasticsearch JavaScript Client

const response = await client.ilm.retry({
  index: "my-index-000001",
});

Python Elasticsearch Python Client

resp = client.ilm.retry(
    index="my-index-000001",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index-000001/_ilm/retry" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ilm().retry(r -> r
    .index("my-index-000001")
);

C# Elasticsearch .NET Client

var response = await client.IndexLifecycleManagement.RetryAsync(index: "my-index-000001");

PHP Elasticsearch PHP Client

$resp = $client->ilm()->retry([
    "index" => "my-index-000001",
]);

Ruby Elasticsearch Ruby Client

response = client.ilm.retry(
  index: "my-index-000001"
)

Response

{
  "acknowledged": false
}

Generated from the API spec