OpenSearch/docs/reference/indices/get-index.asciidoc

[[indices-get-index]]
=== Get index API
++++
<titleabbrev>Get index</titleabbrev>
++++

Returns information about one or more indices. For data streams, the API
returns information about the stream's backing indices.

[source,console]
--------------------------------------------------
GET /my-index-000001
--------------------------------------------------
// TEST[setup:my_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>>.


[[get-index-api-request]]
==== {api-request-title}

`GET /<target>`


[[get-index-api-path-params]]
==== {api-path-parms-title}

`<target>`::
(Required, string)
Comma-separated list of data streams, indices, and index aliases used to limit
the request. Wildcard expressions (`*`) are supported.
+
To target all data streams and indices in a cluster, omit this parameter or use
`_all` or `*`.


[[get-index-api-query-params]]
==== {api-query-parms-title}

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
+
Defaults to `true`.

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
+
Defaults to `open`.

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-defaults]

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-type-name]

`ignore_unavailable`::
(Optional, boolean)
If `false`, requests that target a missing index return an error. Defaults to
`false`.

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]