OpenSearch/docs/java-rest/high-level/ilm/delete_snapshot_lifecycle_p...

37 lines
1.1 KiB
Plaintext

--
:api: slm-delete-snapshot-lifecycle-policy
:request: DeleteSnapshotLifecyclePolicyRequest
:response: AcknowledgedResponse
--
[id="{upid}-{api}"]
=== Delete Snapshot Lifecycle Policy API
[id="{upid}-{api}-request"]
==== Request
The Delete Snapshot Lifecycle Policy API allows you to delete a Snapshot Lifecycle Management Policy
from the cluster.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> The policy with the id `policy_id` will be deleted.
[id="{upid}-{api}-response"]
==== Response
The returned +{response}+ indicates if the delete snapshot lifecycle policy request was received.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
<1> Whether or not the delete snapshot lifecycle policy request was acknowledged.
include::../execution.asciidoc[]