OpenSearch/docs/reference/ilm/actions/ilm-delete.asciidoc

38 lines
710 B
Plaintext

[role="xpack"]
[[ilm-delete]]
=== Delete
Phases allowed: delete.
Permanently removes the index.
[[ilm-delete-options]]
==== Options
`delete_searchable_snapshot`::
beta:[]
(Optional, Boolean)
Deletes the searchable snapshot created in the cold phase.
Defaults to `true`.
This option is applicable when the <<ilm-searchable-snapshot-action,searchable
snapshot>> action is used in the cold phase.
[[ilm-delete-action-ex]]
==== Example
[source,console]
--------------------------------------------------
PUT _ilm/policy/my_policy
{
"policy": {
"phases": {
"delete": {
"actions": {
"delete" : { }
}
}
}
}
}
--------------------------------------------------