Skip to content

Commit 7573146

Browse files
authored
Clarify expand_wildcard option in snapshot docs (#58016)
This commit clarifies that the `expand_wildcards` option (as well as other `IndicesOptions` parameters) can be used with the Create Snapshot API, but that they must be in the body of the request. Also clarifies the connection between `expand_wildcards` and hidden indices as it relates to snapshots.
1 parent 93ff479 commit 7573146

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/reference/snapshot-restore/take-snapshot.asciidoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,14 @@ PUT /_snapshot/my_backup/snapshot_2?wait_for_completion=true
5252
// TEST[skip:cannot complete subsequent snapshot]
5353

5454
The list of indices that should be included into the snapshot can be specified using the `indices` parameter that
55-
supports <<multi-index,multi index syntax>>. The snapshot request also supports the
55+
supports <<multi-index,multi index syntax>>, although the options which control the behavior of multi index syntax
56+
must be supplied in the body of the request, rather than as request parameters. The snapshot request also supports the
5657
`ignore_unavailable` option. Setting it to `true` will cause indices that do not exist to be ignored during snapshot
5758
creation. By default, when `ignore_unavailable` option is not set and an index is missing the snapshot request will fail.
5859
By setting `include_global_state` to false it's possible to prevent the cluster global state to be stored as part of
5960
the snapshot. By default, the entire snapshot will fail if one or more indices participating in the snapshot don't have
60-
all primary shards available. This behaviour can be changed by setting `partial` to `true`.
61+
all primary shards available. This behaviour can be changed by setting `partial` to `true`. The `expand_wildcards`
62+
option can be used to control whether hidden and closed indices will be included in the snapshot, and defaults to `all`.
6163

6264
The `metadata` field can be used to attach arbitrary metadata to the snapshot. This may be a record of who took the snapshot,
6365
why it was taken, or any other data that might be useful.

0 commit comments

Comments
 (0)