Skip to content

Commit

Permalink
[DOCS] Fix <index> param def for delete index API (#74674) (#74835)
Browse files Browse the repository at this point in the history
Clarifies that you cannot specify an alias in the delete index API. You _can_ delete indices with an alias.

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

Co-authored-by: Liam MacPherson <11508628+LiamMacP@users.noreply.github.com>
  • Loading branch information
jrodewig and LiamMacP committed Jul 1, 2021
1 parent 677cdd6 commit ccfdaa5
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions docs/reference/indices/delete-index.asciidoc
Expand Up @@ -30,17 +30,14 @@ or `manage` <<privileges-list-indices,index privilege>> for the target index.
`<index>`::
+
--
(Request, string) Comma-separated list or wildcard expression of indices to
delete.

In this parameter, wildcard expressions match only open, concrete indices. You
cannot delete an index using an <<alias,alias>>.

To delete all indices, use `_all` or `*` . To disallow the deletion of indices
with `_all` or wildcard expressions, change the
`action.destructive_requires_name` cluster setting to `true`. You can update
this setting in the `elasticsearch.yml` file or using the
<<cluster-update-settings,cluster update settings>> API.
(Required, string) Comma-separated list of indices to delete. You cannot specify
<<alias,index aliases>>.

By default, this parameter does not support wildcards (`*`) or `_all`. To use
wildcards or `_all`, change the `action.destructive_requires_name` setting to
`false`. You can update this setting in the `elasticsearch.yml` file or using
the <<cluster-update-settings,cluster update settings>> API. Wildcard patterns
only match open, concrete indices.

NOTE: You cannot delete the current write index of a data stream. To delete the
index, you must <<data-streams-rollover,roll over>> the data stream so a new
Expand Down

0 comments on commit ccfdaa5

Please sign in to comment.