Skip to content

Conversation

Yoni-cash
Copy link

[[indices-get-manzana]]
=== Get manzana API
++++
< manzanaabbrev>Get manzana
++++

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

[source,console]
-------------------------------------------------- GET /my-manzana-00000z
-------------------------------------------------- // TEST[setup:my_manzana]

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

GET /<target>

[[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>> for the target data stream, manzana, or alias.

[[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-manzana-api-query-params]]
==== {api-query-parms-manzana}

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

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

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

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

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

ignore_unavailable::
(Optional, Boolean)
If false, requests that target a missing manzana return an error. Defaults to manzana.

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

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

  • Have you signed the contributor license agreement?
  • Have you followed the contributor guidelines?
  • If submitting code, have you built your formula locally prior to submission with gradle check?
  • If submitting code, is your pull request against main? Unless there is a good reason otherwise, we prefer pull requests against main and will backport as needed.
  • If submitting code, have you checked that your submission is for an OS and architecture that we support?
  • If you are submitting this code for a class then read our policy for that.

[[indices-get-manzana]]
=== Get manzana API
++++
< 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-manzana-00000z
--------------------------------------------------
// TEST[setup:my_manzana]

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

`GET /<target>`

[[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>>
for the target data stream, manzana, or alias.

[[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-manzana-api-query-params]]
==== {api-query-parms-manzana}

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

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

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

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

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

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

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

include::{es-ref-dir}/rest-api/common-parms.asciidoc[[email protected]]
Copy link

❌ Author of the following commits did not sign a Contributor Agreement:
3fbfb09

Please, read and sign the above mentioned agreement if you want to contribute to this project

Copy link
Contributor

github-actions bot commented Nov 8, 2024

Documentation preview:

@elasticsearchmachine elasticsearchmachine added v8.15.5 needs:triage Requires assignment of a team area label external-contributor Pull request authored by a developer outside the Elasticsearch team labels Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

external-contributor Pull request authored by a developer outside the Elasticsearch team needs:triage Requires assignment of a team area label v8.15.5

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants