IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Delete lifecycle policy API Remove policy from index API »

› › ›

Move to lifecycle step API

edit

Move to lifecycle step API

edit

Triggers execution of a specific step in the lifecycle policy.

Request

edit

POST _ilm/move/<index>

Description

edit

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

Manually moves an index into the specified step and executes that step. 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 being executed for the index. This is to prevent the index from being moved from an unexpected step into the next step.

Path Parameters

edit

index (required): (string) Identifier for the index.

Request Parameters

edit

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.

Authorization

edit

You must have the manage_ilm privileges on the indices being managed to use this API. For more information, see Security privileges.

Examples

edit

The following example moves my_index from the initial step to the forcemerge step:

POST _ilm/move/my_index
{
  "current_step": { 
    "phase": "new",
    "action": "complete",
    "name": "complete"
  },
  "next_step": { 
    "phase": "warm",
    "action": "forcemerge",
    "name": "forcemerge"
  }
}

	The step that the index is expected to be in
	The step that you want to execute

If the request succeeds, you receive the following result:

{
  "acknowledged": true
}

The request will fail if the index is not in the new phase as specified by the current_step.

« Delete lifecycle policy API Remove policy from index API »