Skip to content

Commit a4908f8

Browse files
[DOCS] Update wildcard support for removing aliases (#74561) (#74626)
You can now use a wildcard pattern to remove data stream and index aliases in the same action/request. Co-authored-by: Elastic Machine <[email protected]>
1 parent 027fc4e commit a4908f8

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

docs/reference/indices/aliases.asciidoc

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,14 +80,16 @@ The object body contains options for the alias. Supports an empty object.
8080
`alias`::
8181
(Required*, string) Alias for the action. Index alias names support
8282
<<date-math-index-names,date math>>. If `aliases` is not specified, the `add`
83-
and `remove` actions require this parameter. The `remove_index` action doesn't
84-
support this parameter.
83+
and `remove` actions require this parameter. For the `remove` action, this
84+
parameter supports wildcards (`*`). The `remove_index` action doesn't support
85+
this parameter.
8586

8687
`aliases`::
8788
(Required*, array of strings) Aliases for the action. Index alias names support
8889
<<date-math-index-names,date math>>. If `alias` is not specified, the `add` and
89-
`remove` actions require this parameter. The `remove_index` action doesn't
90-
support this parameter.
90+
`remove` actions require this parameter. For the `remove` action, this parameter
91+
supports wildcards (`*`). The `remove_index` action doesn't support this
92+
parameter.
9193

9294
// tag::alias-options[]
9395
`filter`::
@@ -99,13 +101,15 @@ Only the `add` action supports this parameter.
99101

100102
`index`::
101103
(Required*, string) Data stream or index for the action. Supports wildcards
102-
(`*`). Wildcard patterns that match both data streams and indices return an
103-
error. If `indices` is not specified, this parameter is required.
104+
(`*`). If `indices` is not specified, this parameter is required. For the `add`
105+
and `remove_index` actions, wildcard patterns that match both data streams and
106+
indices return an error.
104107

105108
`indices`::
106109
(Required*, array of strings) Data streams or indices for the action. Supports
107-
wildcards (`*`). Wildcard patterns that match both data streams and indices
108-
return an error. If `index` is not specified, this parameter is required.
110+
wildcards (`*`). If `index` is not specified, this parameter is required. For
111+
the `add` and `remove_index` actions, wildcard patterns that match both data
112+
streams and indices return an error.
109113

110114
// tag::alias-options[]
111115
`index_routing`::

docs/reference/indices/delete-alias.asciidoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,7 @@ indices.
3737

3838
`<target>`::
3939
(Required, string) Comma-separated list of data streams or indices used to limit
40-
the request. Supports wildcards (`*`). Wildcard patterns that match both data
41-
streams and indices return an error.
40+
the request. Supports wildcards (`*`).
4241

4342
[[delete-alias-api-query-params]]
4443
==== {api-query-parms-title}

0 commit comments

Comments
 (0)