put_snapshot_lifecycle_policy.asciidoc 1.0 KB

1234567891011121314151617181920212223242526272829303132333435
  1. --
  2. :api: slm-put-snapshot-lifecycle-policy
  3. :request: PutSnapshotLifecyclePolicyRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Put Snapshot Lifecycle Policy API
  9. [id="{upid}-{api}-request"]
  10. ==== Request
  11. The Put Snapshot Lifecycle Policy API allows you to add of update the definition of a Snapshot
  12. Lifecycle Management Policy in the cluster.
  13. ["source","java",subs="attributes,callouts,macros"]
  14. --------------------------------------------------
  15. include-tagged::{doc-tests-file}[{api}-request]
  16. --------------------------------------------------
  17. [id="{upid}-{api}-response"]
  18. ==== Response
  19. The returned +{response}+ indicates if the put 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 put snapshot lifecycle policy was acknowledged.
  25. include::../execution.asciidoc[]