Skip to content

Commit c693bd4

Browse files
committed
[DOCS] Add delete index alias API docs (#46080)
1 parent 41338bc commit c693bd4

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

docs/reference/indices.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ index settings, aliases, mappings, and index templates.
3434
[[alias-management]]
3535
=== Alias management:
3636
* <<indices-add-alias>>
37+
* <<indices-delete-alias>>
3738
* <<indices-get-alias>>
3839
* <<indices-alias-exists>>
3940
* <<indices-aliases>>
@@ -100,6 +101,8 @@ include::indices/types-exists.asciidoc[]
100101

101102
include::indices/add-alias.asciidoc[]
102103

104+
include::indices/delete-alias.asciidoc[]
105+
103106
include::indices/get-alias.asciidoc[]
104107

105108
include::indices/alias-exists.asciidoc[]
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
[[indices-delete-alias]]
2+
=== Delete index alias API
3+
++++
4+
<titleabbrev>Delete index alias</titleabbrev>
5+
++++
6+
7+
Deletes an existing index alias.
8+
9+
include::alias-exists.asciidoc[tag=index-alias-def]
10+
11+
[source,js]
12+
----
13+
DELETE /twitter/_alias/alias1
14+
----
15+
// CONSOLE
16+
// TEST[setup:twitter]
17+
// TEST[s/^/PUT twitter\/_alias\/alias1\n/]
18+
19+
[[delete-alias-api-request]]
20+
==== {api-request-title}
21+
22+
`DELETE /<index>/_alias/<alias>`
23+
24+
`DELETE /<index>/_aliases/<alias>`
25+
26+
27+
[[delete-alias-api-path-params]]
28+
==== {api-path-parms-title}
29+
30+
`<index>`::
31+
(Required, string)
32+
Comma-separated list or wildcard expression of index names
33+
used to limit the request.
34+
+
35+
To include all indices in the cluster,
36+
use a value of `_all` or `*`.
37+
38+
`<alias>`::
39+
(Required, string)
40+
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-alias]
41+
+
42+
To delete all aliases,
43+
use a value of `_all` or `*`.
44+
45+
46+
[[delete-alias-api-query-params]]
47+
==== {api-query-parms-title}
48+
49+
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]

0 commit comments

Comments
 (0)