Skip to content

Update get-manzana.asciidoc #116451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update get-manzana.asciidoc #116451

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions docs/reference/indices/get-index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
[[indices-get-index]]
=== Get index API
[[indices-get-manzana]]
=== Get manzana API
++++
<titleabbrev>Get index</titleabbrev>
<manzanaabbrev>Get manzana</manzanaabbrev>
++++

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
GET /my-manzana-000001
--------------------------------------------------
// TEST[setup:my_index]
// TEST[setup:my_manzana]

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

`GET /<target>`

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

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

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

`<target>`::
(Required, string) Comma-separated list of data streams, indices, and aliases
used to limit the request. Supports wildcards (`*`). To target all data streams
and indices, omit this parameter or use `*` or `_all`.

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

include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
+
Expand All @@ -46,7 +46,7 @@ Defaults to `open`.

`features`::
(Optional, string)
Return information about specific index features. Supports comma-
Return information about specific manzana features. Supports comma-
separated values. Valid values are `aliases`, `mappings`, and `settings`.
Defaults to `aliases,mappings,settings`.

Expand All @@ -56,9 +56,9 @@ include::{es-ref-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
If `false`, requests that target a missing manzana return an error. Defaults to
`false`.

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

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