Create lifecycle policy API
editCreate lifecycle policy API
editCreates or updates lifecycle policy. See Policy phases and actions for definitions of policy components.
Request
editPUT _ilm/policy/<policy_id>
Description
editCreates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented.
Only the latest version of the policy is stored, you cannot revert to previous versions.
Path Parameters
edit-
policy(required) - (string) Identifier for the policy.
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
editYou must have the manage_ilm cluster privilege to use this API. You must
also have the manage index privilege on all indices being managed by policy.
All operations executed by index lifecycle management for a policy are executed as the user that
put the latest version of a policy.
For more information, see Security privileges.
Examples
editThe following example creates a new policy named my_policy:
PUT _ilm/policy/my_policy
{
"policy": {
"phases": {
"warm": {
"min_age": "10d",
"actions": {
"forcemerge": {
"max_num_segments": 1
}
}
},
"delete": {
"min_age": "30d",
"actions": {
"delete": {}
}
}
}
}
}
If the request succeeds, you receive the following result:
{
"acknowledged": true
}