Run a policy Generally available; Added in 7.4.0

PUT /_slm/policy/{policy_id}/_execute
Api key auth Basic auth Bearer auth

Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.

Required authorization

  • Cluster privileges: manage_slm

Path parameters

  • policy_id string Required

    The id of the snapshot lifecycle policy to be executed

Query parameters

  • master_timeout string

    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.

    External documentation
  • timeout string

    The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

    External documentation

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • snapshot_name string Required
PUT /_slm/policy/{policy_id}/_execute 
PUT /_slm/policy/daily-snapshots/_execute

resp = client.slm.execute_lifecycle(
    policy_id="daily-snapshots",
)
const response = await client.slm.executeLifecycle({
  policy_id: "daily-snapshots",
});
response = client.slm.execute_lifecycle(
  policy_id: "daily-snapshots"
)
$resp = $client->slm()->executeLifecycle([
    "policy_id" => "daily-snapshots",
]);
curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_slm/policy/daily-snapshots/_execute"
Response examples (200)
Run `POST /_slm/policy/daily-snapshots/_execute` to take an immediate snapshot according to the `daily-snapshots` policy. 
{
  "snapshot_name": "daily-snap-2019.04.24-gwrqoo2xtea3q57vvg0uea"
}