Type to search.

Move to a lifecycle step

Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 6.6 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Manually move an index into a specific step in the lifecycle policy and run that step.

Warning

This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API.

You must specify both the current step and the step to be executed in the body of the request. The request will fail if the current step does not match the step currently running for the index This is to prevent the index from being moved from an unexpected step into the next step.

When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. If only the phase is specified, the index will move to the first step of the first action in the target phase. If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. Only actions specified in the ILM policy are considered valid. An index cannot move to a step that is not part of its policy.

Required privileges

Index privileges manage_ilm

Path parameters

index string required

The name of the index whose lifecycle step is to change

Request body

current_step object required

The step that the index is expected to be in.

action string

The optional action to which the index will be moved.

name string

The optional step name to which the index will be moved.

phase string required
next_step object required

The step that you want to run.

action string

The optional action to which the index will be moved.

name string

The optional step name to which the index will be moved.

phase string required

Response

application/json
acknowledged boolean required

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