› › ›

Wait for snapshot

Phases allowed: delete.

Waits for the specified SLM policy to be executed before removing the index. This ensures that a snapshot of the deleted index is available.

Options

policy: (Required, string) Name of the SLM policy that the delete action should wait for.

Example

resp = client.ilm.put_lifecycle(
    name="my_policy",
    policy={
        "phases": {
            "delete": {
                "actions": {
                    "wait_for_snapshot": {
                        "policy": "slm-policy-name"
                    }
                }
            }
        }
    },
)
print(resp)

const response = await client.ilm.putLifecycle({
  name: "my_policy",
  policy: {
    phases: {
      delete: {
        actions: {
          wait_for_snapshot: {
            policy: "slm-policy-name",
          },
        },
      },
    },
  },
});
console.log(response);

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "delete": {
        "actions": {
          "wait_for_snapshot" : {
            "policy": "slm-policy-name"
          }
        }
      }
    }
  }
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-wait-for-snapshot.html