Get snapshot lifecycle policy API

Returns information about one or more snapshot lifecycle policies.

Request

GET /_slm/policy/<snapshot-lifecycle-policy-id>

GET /_slm/policy/

Description

Use the snapshot lifecycle policy API to retrieve information about one or more snapshot lifecycle policies. The API response also includes information about the latest successful and failed attempts to create automatic snapshots.

Path parameters

<snapshot-lifecycle-policy-id>
(Optional, string) Comma-separated list of snapshot lifecycle policy IDs to retrieve.

Examples

Get a specific policy

GET /_slm/policy/daily-snapshots?human

The API returns the following response:

{
  "daily-snapshots" : {
    "version": 1, 
    "modified_date": "2019-04-23T01:30:00.000Z", 
    "modified_date_millis": 1556048137314,
    "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": "2019-04-24T01:30:00.000Z", 
    "next_execution_millis": 1556048160000
  }
}

The version of the snapshot policy, only the latest version is stored and incremented when the policy is updated

The last time this policy was modified.

The next time this policy will be executed.

Get all policies

GET /_slm/policy