Get snapshot lifecycle policy APIedit

Returns information about one or more snapshot lifecycle policies.

Requestedit

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

GET /_slm/policy/

Descriptionedit

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 parametersedit

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

Examplesedit

Get a specific policyedit

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
      }
    },
    "next_execution": "2019-04-24T01:30:00.000Z", 
    "next_execution_millis": 1556048160000
  }
}

The version of the snapshot policy, only the latest verison 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 policiesedit

GET /_slm/policy