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