This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Get snapshot lifecycle management status API Start snapshot lifecycle management API »
Elastic Docs ›Elasticsearch Guide [master] ›REST APIs ›Snapshot lifecycle management APIs

Get snapshot lifecycle stats API

edit

Get snapshot lifecycle stats API

edit

Returns global and policy-level statistics about actions taken by snapshot lifecycle management.

Request

edit

GET /_slm/stats

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the manage_slm cluster privilege to use this API. For more information, see Security privileges.

Examples

edit
resp = client.slm.get_stats()
print(resp)
response = client.slm.get_stats
puts response
const response = await client.slm.getStats();
console.log(response);
GET /_slm/stats

The API returns the following response:

{
  "retention_runs": 13,
  "retention_failed": 0,
  "retention_timed_out": 0,
  "retention_deletion_time": "1.4s",
  "retention_deletion_time_millis": 1404,
  "policy_stats": [ ],
  "total_snapshots_taken": 1,
  "total_snapshots_failed": 1,
  "total_snapshots_deleted": 0,
  "total_snapshot_deletion_failures": 0
}
« Get snapshot lifecycle management status API Start snapshot lifecycle management API »