elasticsearch/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]

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

`GET /<target>`

[[get-index-api-prereqs]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have the
`view_index_metadata` or `manage` <<privileges-list-indices,index privilege>>
for the target data stream, index, or index alias.

[[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]

`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]