2020-02-04 19:45:18 -05:00
|
|
|
[role="xpack"]
|
|
|
|
|
[testenv="basic"]
|
|
|
|
|
[[snapshot-lifecycle-management-api]]
|
|
|
|
|
== {slm-cap} API
|
|
|
|
|
|
|
|
|
|
You use the following APIs to set up policies to automatically take snapshots and
|
|
|
|
|
control how long they are retained.
|
|
|
|
|
For more information about {slm} ({slm-init}), see <<snapshot-lifecycle-management>>.
|
|
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2020-02-04 19:45:18 -05:00
|
|
|
[[slm-api-policy-endpoint]]
|
|
|
|
|
=== Policy management APIs
|
|
|
|
|
|
|
|
|
|
* <<slm-api-put-policy,Create lifecycle policy>>
|
|
|
|
|
* <<slm-api-get-policy,Get lifecycle policy>>
|
|
|
|
|
* <<slm-api-delete-policy,Delete lifecycle policy>>
|
|
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2020-02-04 19:45:18 -05:00
|
|
|
[[slm-api-index-endpoint]]
|
|
|
|
|
=== Snapshot management APIs
|
|
|
|
|
|
|
|
|
|
* <<slm-api-execute-lifecycle,Execute snapshot lifecycle policy>> (take snapshots)
|
|
|
|
|
* <<slm-api-execute-retention,Execute snapshot retention policy>> (delete expired snapshots)
|
|
|
|
|
|
2020-07-23 12:42:33 -04:00
|
|
|
[discrete]
|
2020-02-04 19:45:18 -05:00
|
|
|
[[slm-api-management-endpoint]]
|
|
|
|
|
=== Operation management APIs
|
|
|
|
|
|
|
|
|
|
* <<slm-api-get-status,Get {slm-init} status>>
|
|
|
|
|
* <<slm-api-get-stats,Get global and policy-level action statistics>>
|
|
|
|
|
* <<slm-api-start,Start {slm-init}>>
|
|
|
|
|
* <<slm-api-stop,Stop {slm-init}>>
|
|
|
|
|
|
|
|
|
|
include::slm-put.asciidoc[]
|
|
|
|
|
include::slm-get.asciidoc[]
|
|
|
|
|
include::slm-delete.asciidoc[]
|
|
|
|
|
|
|
|
|
|
include::slm-execute.asciidoc[]
|
|
|
|
|
include::slm-execute-retention.asciidoc[]
|
|
|
|
|
|
|
|
|
|
include::slm-get-status.asciidoc[]
|
|
|
|
|
include::slm-stats.asciidoc[]
|
|
|
|
|
include::slm-start.asciidoc[]
|
|
|
|
|
include::slm-stop.asciidoc[]
|
