start_snapshot_lifecycle_management.asciidoc 1015 B

123456789101112131415161718192021222324252627282930313233343536
  1. --
  2. :api: slm-start-slm
  3. :request: StartSLMRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Start Snapshot Lifecycle Management API
  9. [id="{upid}-{api}-request"]
  10. ==== Request
  11. The Start Snapshot Lifecycle Management API allows you to start Snapshot
  12. Lifecycle Management if it has previously been stopped.
  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 request to start Snapshot Lifecycle
  20. Management 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 request to start Snapshot Lifecycle Management was
  26. acknowledged.
  27. include::../execution.asciidoc[]