-
Notifications
You must be signed in to change notification settings - Fork 24.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Add "index template exists" API docs (#46095)
- Loading branch information
Showing
4 changed files
with
76 additions
and
25 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
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 |
---|---|---|
@@ -0,0 +1,56 @@ | ||
[[indices-template-exists]] | ||
=== Index template exists API | ||
++++ | ||
<titleabbrev>Index template exists</titleabbrev> | ||
++++ | ||
|
||
Checks if an index template exists. | ||
|
||
|
||
|
||
[source,js] | ||
----------------------------------------------- | ||
HEAD /_template/template_1 | ||
----------------------------------------------- | ||
// CONSOLE | ||
|
||
|
||
[[template-exists-api-request]] | ||
==== {api-request-title} | ||
|
||
`HEAD /_template/<index-template>` | ||
|
||
|
||
[[template-exists-api-desc]] | ||
==== {api-description-title} | ||
|
||
Use the index template exists API | ||
to determine whether one or more index templates exist. | ||
|
||
include::templates.asciidoc[tag=index-template-def] | ||
|
||
|
||
[[template-exists-api-path-params]] | ||
==== {api-path-parms-title} | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-template] | ||
|
||
|
||
[[template-exists-api-query-params]] | ||
==== {api-query-parms-title} | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=local] | ||
|
||
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] | ||
|
||
|
||
[[template-exists-api-response-codes]] | ||
==== {api-response-codes-title} | ||
|
||
`200`:: | ||
Indicates all specified index templates exist. | ||
|
||
`404`:: | ||
Indicates one or more specified index templates **do not** exist. |
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
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