-
Notifications
You must be signed in to change notification settings - Fork 24.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Reformat indices exists API docs (#45918)
- Loading branch information
Showing
1 changed file
with
48 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,59 @@ | ||
[[indices-exists]] | ||
=== Indices Exists | ||
=== Indices exists API | ||
++++ | ||
<titleabbrev>Indices exists</titleabbrev> | ||
++++ | ||
|
||
Used to check if the index (indices) exists or not. For example: | ||
Checks if an index exists. | ||
The returned HTTP status code indicates if the index exists or not. | ||
A `404` means it does not exist, and `200` means it does. | ||
|
||
[source,js] | ||
-------------------------------------------------- | ||
HEAD twitter | ||
HEAD /twitter | ||
-------------------------------------------------- | ||
// CONSOLE | ||
// TEST[setup:twitter] | ||
|
||
The HTTP status code indicates if the index exists or not. A `404` means | ||
it does not exist, and `200` means it does. | ||
|
||
IMPORTANT: This request does not distinguish between an index and an alias, | ||
[[indices-exists-api-request]] | ||
==== {api-request-title} | ||
|
||
`HEAD /<index>` | ||
|
||
|
||
[[indices-exists-api-path-params]] | ||
==== {api-path-parms-title} | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=index] | ||
+ | ||
IMPORTANT: This parameter does not distinguish between an index name and <<indices-aliases,alias>>, | ||
i.e. status code `200` is also returned if an alias exists with that name. | ||
|
||
|
||
[[indices-exists-api-query-params]] | ||
==== {api-query-parms-title} | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] | ||
+ | ||
Defaults to `open`. | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=include-defaults] | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=local] | ||
|
||
|
||
[[indices-exists-api-response-codes]] | ||
==== {api-response-codes-title} | ||
|
||
`200`:: | ||
Indicates all specified indices or index aliases exist. | ||
|
||
`404`:: | ||
Indicates one or more specified indices or index aliases **do not** exist. |