Get policy information

GET /_slm/policy/{policy_id}
GET /_slm/policy

Auth

Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.

Required privileges

Cluster privileges manage_slm

Path parameters

policy_id union string | string[] optional

A comma-separated list of snapshot lifecycle policy identifiers.

Leave it out to use /_slm/policy.

Query parameters

master_timeout string · default: 30s: The 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.
timeout string · default: 30s: The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Response

application/json

<string> object

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _slm/policy/daily-snapshots?human

JavaScript Elasticsearch JavaScript Client

const response = await client.slm.getLifecycle({
  policy_id: "daily-snapshots",
  human: "true",
});

Python Elasticsearch Python Client

resp = client.slm.get_lifecycle(
    policy_id="daily-snapshots",
    human=True,
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_slm/policy/daily-snapshots?human" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.slm().getLifecycle(g -> g
    .policyId("daily-snapshots")
);

C# Elasticsearch .NET Client

var response = await client.SnapshotLifecycleManagement
    .GetLifecycleAsync(d1 => d1
        .PolicyId(new[] { "daily-snapshots" })
    );

PHP Elasticsearch PHP Client

$resp = $client->slm()->getLifecycle([
    "policy_id" => "daily-snapshots",
    "human" => "true",
]);

Ruby Elasticsearch Ruby Client

response = client.slm.get_lifecycle(
  policy_id: "daily-snapshots",
  human: "true"
)

Response

A successful response from GET _slm/policy/daily-snapshots?human.

{
  "daily-snapshots": {
    "version": 1,
    "modified_date": "2099-05-06T01:30:00.000Z",
    "modified_date_millis": 4081757400000,
    "policy" : {
      "schedule": "0 30 1 * * ?",
      "name": "<daily-snap-{now/d}>",
      "repository": "my_repository",
      "config": {
        "indices": ["data-*", "important"],
        "ignore_unavailable": false,
        "include_global_state": false
      },
      "retention": {
        "expire_after": "30d",
        "min_count": 5,
        "max_count": 50
      }
    },
    "stats": {
      "policy": "daily-snapshots",
      "snapshots_taken": 0,
      "snapshots_failed": 0,
      "snapshots_deleted": 0,
      "snapshot_deletion_failures": 0
    },
    "next_execution": "2099-05-07T01:30:00.000Z",
    "next_execution_millis": 4081843800000
  }
}