delete_snapshot_lifecycle_policy.asciidoc 1.1 KB

123456789101112131415161718192021222324252627282930313233343536
  1. --
  2. :api: slm-delete-snapshot-lifecycle-policy
  3. :request: DeleteSnapshotLifecyclePolicyRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Delete Snapshot Lifecycle Policy API
  9. [id="{upid}-{api}-request"]
  10. ==== Request
  11. The Delete Snapshot Lifecycle Policy API allows you to delete a Snapshot Lifecycle Management Policy
  12. from the cluster.
  13. ["source","java",subs="attributes,callouts,macros"]
  14. --------------------------------------------------
  15. include-tagged::{doc-tests-file}[{api}-request]
  16. --------------------------------------------------
  17. <1> The policy with the id `policy_id` will be deleted.
  18. [id="{upid}-{api}-response"]
  19. ==== Response
  20. The returned +{response}+ indicates if the delete snapshot lifecycle policy request was received.
  21. ["source","java",subs="attributes,callouts,macros"]
  22. --------------------------------------------------
  23. include-tagged::{doc-tests-file}[{api}-response]
  24. --------------------------------------------------
  25. <1> Whether or not the delete snapshot lifecycle policy request was acknowledged.
  26. include::../execution.asciidoc[]