mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 15:47:23 -04:00
33a7f066e1
In #48632 we removed support for `include_type_name` in the REST API. This PR removes it from the API spec and documentation.
51 lines
No EOL
1.2 KiB
Text
51 lines
No EOL
1.2 KiB
Text
[[indices-get-index]]
|
|
=== Get index API
|
|
++++
|
|
<titleabbrev>Get index</titleabbrev>
|
|
++++
|
|
|
|
Returns information about one or more indexes.
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /twitter
|
|
--------------------------------------------------
|
|
// TEST[setup:twitter]
|
|
|
|
[[get-index-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET /<index>`
|
|
|
|
|
|
[[get-index-api-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<index>`::
|
|
+
|
|
--
|
|
(Required, string) Comma-separated list or wildcard expression of index names
|
|
used to limit the request.
|
|
|
|
Use a value of `_all` to retrieve information for all indices in the cluster.
|
|
--
|
|
|
|
|
|
[[get-index-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]
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] |