slm-api.asciidoc 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[snapshot-lifecycle-management-api]]
  4. == {slm-cap} APIs
  5. You use the following APIs to set up policies to automatically take snapshots and
  6. control how long they are retained.
  7. For more information about {slm} ({slm-init}), see <<snapshot-lifecycle-management>>.
  8. [discrete]
  9. [[slm-api-policy-endpoint]]
  10. === Policy management APIs
  11. * <<slm-api-put-policy,Create lifecycle policy>>
  12. * <<slm-api-get-policy,Get lifecycle policy>>
  13. * <<slm-api-delete-policy,Delete lifecycle policy>>
  14. [discrete]
  15. [[slm-api-index-endpoint]]
  16. === Snapshot management APIs
  17. * <<slm-api-execute-lifecycle,Execute snapshot lifecycle policy>> (take snapshots)
  18. * <<slm-api-execute-retention,Execute snapshot retention policy>> (delete expired snapshots)
  19. [discrete]
  20. [[slm-api-management-endpoint]]
  21. === Operation management APIs
  22. * <<slm-api-get-status,Get {slm-init} status>>
  23. * <<slm-api-get-stats,Get global and policy-level action statistics>>
  24. * <<slm-api-start,Start {slm-init}>>
  25. * <<slm-api-stop,Stop {slm-init}>>
  26. include::slm-put.asciidoc[]
  27. include::slm-get.asciidoc[]
  28. include::slm-delete.asciidoc[]
  29. include::slm-execute.asciidoc[]
  30. include::slm-execute-retention.asciidoc[]
  31. include::slm-get-status.asciidoc[]
  32. include::slm-stats.asciidoc[]
  33. include::slm-start.asciidoc[]
  34. include::slm-stop.asciidoc[]