Get snapshot lifecycle policy API

Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.

Request

GET /_slm/policy/<policy-id>

GET /_slm/policy

Prerequisites

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.

Description

Returns the specified policy definition and information about the latest successful and failed attempts to create snapshots. If no policy is specified, returns all defined policies.

Path parameters

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

Examples

Get a specific policy

Get the daily-snapshots policy:

GET /_slm/policy/daily-snapshots?human

This request 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 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 policies

GET /_slm/policy