mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 21:48:39 +00:00
a63f60b776
Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
22 lines
801 B
Plaintext
22 lines
801 B
Plaintext
[[indices-get-index]]
|
|
=== Get Index
|
|
|
|
The get index API allows to retrieve information about one or more indexes.
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /twitter
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[setup:twitter]
|
|
|
|
The above example gets the information for an index called `twitter`. Specifying an index,
|
|
alias or wildcard expression is required.
|
|
|
|
The get index API can also be applied to more than one index, or on
|
|
all indices by using `_all` or `*` as index.
|
|
|
|
NOTE: Before 7.0.0, the 'mappings' definition used to include a type name. Although mappings
|
|
in responses no longer contain a type name by default, you can still request the old format
|
|
through the parameter include_type_name. For more details, please see <<removal-of-types>>.
|