Create a snapshot

POST also PUT /_snapshot/{repository}/{snapshot}

Take a snapshot of a cluster or of data streams and indices.

Required authorization

Cluster privileges: create_snapshot

Request

expand_wildcards string ExpandWildcards · default: all

Determines how wildcard patterns in the indices parameter match data streams and indices. It supports comma-separated values such as open,hidden.

Supported values include:

all: Match any data stream or index, including hidden ones.
open: Match open, non-hidden indices. Also matches any non-hidden data stream.
closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
none: Wildcard expressions are not accepted.

Values: all open closed hidden none

feature_states [] string

The feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API.

If include_global_state is true, all current feature states are included by default. If include_global_state is false, no feature states are included by default.

Note that specifying an empty array will result in the default behavior. To exclude all feature states, regardless of the include_global_state value, specify an array with only the value none (["none"]).

Reference

ignore_unavailable boolean · default: false

If true, the request ignores data streams and indices in indices that are missing or closed. If false, the request returns an error for any data stream or index that is missing or closed.

include_global_state boolean · default: true

If true, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via feature_states).

indices string Indices

A comma-separated list of data streams and indices to include in the snapshot. It supports a multi-target syntax. The default is an empty array ([]), which includes all regular data streams and regular indices. To exclude all data streams and indices, use -*.

You can't use this parameter to include or exclude system indices or system data streams from a snapshot. Use feature_states instead.

metadata Metadata

Arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. It can have any contents but it must be less than 1024 bytes. This information is not automatically generated by Elasticsearch.

partial boolean · default: false

If true, allows the snapshot to proceed even if some of the target shards are unavailable. In this case, the resulting snapshot will not contain snapshots of the unavailable target shards, and will report its state as PARTIAL. Additionally, if true, allows index metadata operations such as deletions while the snapshot is in progress. This is almost always preferable to failing the snapshot completely when a single shard is unavailable, and blocking index metadata operations.

If false, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available, and index metadata operations such as deletions will be forbidden until the snapshot completes.

Response

application/json

Examples

Run POST /_snapshot/my_repository/snapshot_2?wait_for_completion=true to take a snapshot of index_1 and index_2.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /_snapshot/my_repository/snapshot_2?wait_for_completion=true
{
  "partial": true,
  "indices": "index_1,index_2",
  "ignore_unavailable": true,
  "include_global_state": false,
  "metadata": {
    "taken_by": "user123",
    "taken_because": "backup before upgrading"
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.snapshot.create({
  repository: "my_repository",
  snapshot: "snapshot_2",
  wait_for_completion: "true",
  partial: true,
  indices: "index_1,index_2",
  ignore_unavailable: true,
  include_global_state: false,
  metadata: {
    taken_by: "user123",
    taken_because: "backup before upgrading",
  },
});

Python Elasticsearch Python Client

resp = client.snapshot.create(
    repository="my_repository",
    snapshot="snapshot_2",
    wait_for_completion=True,
    partial=True,
    indices="index_1,index_2",
    ignore_unavailable=True,
    include_global_state=False,
    metadata={
        "taken_by": "user123",
        "taken_because": "backup before upgrading"
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_snapshot/my_repository/snapshot_2?wait_for_completion=true" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "partial": true,
    "indices": "index_1,index_2",
    "ignore_unavailable": true,
    "include_global_state": false,
    "metadata": {
      "taken_by": "user123",
      "taken_because": "backup before upgrading"
    }
  }'

Java Elasticsearch Java Client

client.snapshot().create(c -> c
    .ignoreUnavailable(true)
    .includeGlobalState(false)
    .indices("index_1,index_2")
    .metadata(Map.of("taken_by", JsonData.fromJson("\"user123\""),"taken_because", JsonData.fromJson("\"backup before upgrading\"")))
    .partial(true)
    .repository("my_repository")
    .snapshot("snapshot_2")
    .waitForCompletion(true)
);

C# Elasticsearch .NET Client

var response = await client.Snapshot
    .CreateAsync(repository: "my_repository", snapshot: "snapshot_2", d1 => d1
        .WaitForCompletion(true)
        .IgnoreUnavailable(true)
        .IncludeGlobalState(false)
        .Indices(new[] { "index_1,index_2" })
        .Metadata(new Dictionary<string, object>()
        {
            { "taken_by", "user123" },
            { "taken_because", "backup before upgrading" }
        })
        .Partial(true)
    );

PHP Elasticsearch PHP Client

$resp = $client->snapshot()->create([
    "repository" => "my_repository",
    "snapshot" => "snapshot_2",
    "wait_for_completion" => "true",
    "body" => [
        "partial" => true,
        "indices" => "index_1,index_2",
        "ignore_unavailable" => true,
        "include_global_state" => false,
        "metadata" => [
            "taken_by" => "user123",
            "taken_because" => "backup before upgrading",
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.snapshot.create(
  repository: "my_repository",
  snapshot: "snapshot_2",
  wait_for_completion: "true",
  body: {
    "partial": true,
    "indices": "index_1,index_2",
    "ignore_unavailable": true,
    "include_global_state": false,
    "metadata": {
      "taken_by": "user123",
      "taken_because": "backup before upgrading"
    }
  }
)

Response

{
  "snapshot": {
    "snapshot": "snapshot_2",
    "uuid": "vdRctLCxSketdKb54xw67g",
    "repository": "my_repository",
    "version_id": <version_id>,
    "version": <version>,
    "indices": [],
    "data_streams": [],
    "feature_states": [],
    "include_global_state": false,
    "metadata": {
      "taken_by": "user123",
      "taken_because": "backup before upgrading"
    },
    "state": "SUCCESS",
    "start_time": "2020-06-25T14:00:28.850Z",
    "start_time_in_millis": 1593093628850,
    "end_time": "2020-06-25T14:00:28.850Z",
    "end_time_in_millis": 1593094752018,
    "duration_in_millis": 0,
    "failures": [],
    "shards": {
      "total": 0,
      "failed": 0,
      "successful": 0
    }
  }
}

Create a snapshot

Required authorization

Path Parameters

Query Parameters

Request

Response

Required authorization

Path Parameters { repository , snapshot , }

Query Parameters { master_timeout , wait_for_completion , }

Request { expand_wildcards , feature_states , ignore_unavailable , include_global_state , indices , metadata , partial , }

Response

Path Parameters

Query Parameters

Request