Get snapshot lifecycle management statistics

GET /_slm/stats

Auth

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

Required privileges

Cluster privileges manage_slm

Query parameters

master_timeout union oneOf · default: 30s: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.; Values: -1 0
timeout union oneOf · default: 30s: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.; Values: -1 0

Response

application/json

retention_deletion_time union oneOf required: Values: -1 0
retention_deletion_time_millis number required
retention_failed number required
retention_runs number required
retention_timed_out number required
total_snapshots_deleted number required
total_snapshot_deletion_failures number required
total_snapshots_failed number required
total_snapshots_taken number required
policy_stats object[] required

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_slm/stats

JavaScript Elasticsearch JavaScript Client

const response = await client.slm.getStats();

Python Elasticsearch Python Client

resp = client.slm.get_stats()

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_slm/stats" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.slm().getStats(g -> g);

C# Elasticsearch .NET Client

var response = await client.SnapshotLifecycleManagement.GetStatsAsync();

PHP Elasticsearch PHP Client

$resp = $client->slm()->getStats();

Ruby Elasticsearch Ruby Client

response = client.slm.get_stats

Response

A successful response from GET /_slm/stats.

{
  "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
}