OpenSearch/docs/reference/indices.asciidoc

[[indices]]
= Indices APIs

[partintro]
--
The indices APIs are used to manage individual indices,
index settings, aliases, mappings, index templates
and warmers.

[float]
[[index-management]]
== Index management:

* <<indices-create-index>>
* <<indices-delete-index>>
* <<indices-get-index>>
* <<indices-exists>>
* <<indices-open-close>>

[float]
[[mapping-management]]
== Mapping management:

* <<indices-put-mapping>>
* <<indices-get-mapping>>
* <<indices-get-field-mapping>>
* <<indices-delete-mapping>>
* <<indices-types-exists>>

[float]
[[alias-management]]
== Alias management:
* <<indices-aliases>>

[float]
[[index-settings]]
== Index settings:
* <<indices-update-settings>>
* <<indices-get-settings>>
* <<indices-analyze>>
* <<indices-templates>>
* <<indices-warmers>>

[float]
[[monitoring]]
== Monitoring:
* <<indices-stats>>
* <<indices-segments>>
* <<indices-recovery>>

[float]
[[status-management]]
== Status management:
* <<indices-clearcache>>
* <<indices-refresh>>
* <<indices-flush>>
* <<indices-optimize>>
* <<indices-upgrade>>

--

include::indices/create-index.asciidoc[]

include::indices/delete-index.asciidoc[]

include::indices/get-index.asciidoc[]

include::indices/indices-exists.asciidoc[]

include::indices/open-close.asciidoc[]

include::indices/put-mapping.asciidoc[]

include::indices/get-mapping.asciidoc[]

include::indices/get-field-mapping.asciidoc[]

include::indices/types-exists.asciidoc[]

include::indices/delete-mapping.asciidoc[]

include::indices/aliases.asciidoc[]

include::indices/update-settings.asciidoc[]

include::indices/get-settings.asciidoc[]

include::indices/analyze.asciidoc[]

include::indices/templates.asciidoc[]

include::indices/warmers.asciidoc[]

include::indices/stats.asciidoc[]

include::indices/segments.asciidoc[]

include::indices/recovery.asciidoc[]

include::indices/clearcache.asciidoc[]

include::indices/flush.asciidoc[]

include::indices/refresh.asciidoc[]

include::indices/optimize.asciidoc[]

include::indices/upgrade.asciidoc[]
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`[[indices]]`
			`= Indices APIs`

			`[partintro]`
			`--`
			`The indices APIs are used to manage individual indices,`
			`index settings, aliases, mappings, index templates`
			`and warmers.`

			`[float]`
Add more anchor links to documentation Related to #3679 2013-09-25 12:17:40 -04:00			`[[index-management]]`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`== Index management:`

			`* <<indices-create-index>>`
			`* <<indices-delete-index>>`
Indices API: Added GET Index API Returns information about settings, aliases, warmers, and mappings. Basically returns the IndexMetadata. This new endpoint replaces the /{index}/_alias\|_aliases\|_mapping\|_mappings\|_settings\|_warmer\|_warmers and /_alias\|_aliases\|_mapping\|_mappings\|_settings\|_warmer\|_warmers endpoints whilst maintaining the same response formats. The only exception to this is on the /_alias\|_aliases\|_warmer\|_warmers endpoint which will now return a section for 'aliases' or 'warmers' even if no aliases or warmers exist. This backwards compatibility change is documented in the reference docs. Closes #4069 2014-08-12 06:42:12 -04:00			`* <<indices-get-index>>`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`* <<indices-exists>>`
			`* <<indices-open-close>>`

			`[float]`
Add more anchor links to documentation Related to #3679 2013-09-25 12:17:40 -04:00			`[[mapping-management]]`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`== Mapping management:`

			`* <<indices-put-mapping>>`
Add a GetFieldMapping API This new API allows to get the mapping for a specific set of fields rather than get the whole index mapping and traverse it. The fields to be retrieved can be specified by their full path, index name and field name and will be resolved in this order. In case multiple field match, the first one will be returned. Since we are now generating the output (rather then fall back to the stored mapping), you can specify `include_defaults`=true on the request to have default values returned. Closes #3941 2013-10-14 02:53:07 -04:00			`* <<indices-get-mapping>>`
			`* <<indices-get-field-mapping>>`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`* <<indices-delete-mapping>>`
			`* <<indices-types-exists>>`

			`[float]`
Add more anchor links to documentation Related to #3679 2013-09-25 12:17:40 -04:00			`[[alias-management]]`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`== Alias management:`
			`* <<indices-aliases>>`

			`[float]`
Add more anchor links to documentation Related to #3679 2013-09-25 12:17:40 -04:00			`[[index-settings]]`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`== Index settings:`
			`* <<indices-update-settings>>`
			`* <<indices-get-settings>>`
			`* <<indices-analyze>>`
			`* <<indices-templates>>`
			`* <<indices-warmers>>`

			`[float]`
Add more anchor links to documentation Related to #3679 2013-09-25 12:17:40 -04:00			`[[monitoring]]`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`== Monitoring:`
			`* <<indices-stats>>`
			`* <<indices-segments>>`
Recovery API Adds a new API endpoint at /_recovery as well as to the Java API. The recovery API allows one to see the recovery status of all shards in the cluster. It will report on percent complete, recovery type, and which files are copied. Closes #4637 2014-02-18 17:28:49 -05:00			`* <<indices-recovery>>`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
			`[float]`
Add more anchor links to documentation Related to #3679 2013-09-25 12:17:40 -04:00			`[[status-management]]`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`== Status management:`
			`* <<indices-clearcache>>`
			`* <<indices-refresh>>`
			`* <<indices-flush>>`
			`* <<indices-optimize>>`
Add link to new upgrade docs from indices page. See #7922. 2014-10-10 13:52:11 -04:00			`* <<indices-upgrade>>`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
			`--`

			`include::indices/create-index.asciidoc[]`

			`include::indices/delete-index.asciidoc[]`

Indices API: Added GET Index API Returns information about settings, aliases, warmers, and mappings. Basically returns the IndexMetadata. This new endpoint replaces the /{index}/_alias\|_aliases\|_mapping\|_mappings\|_settings\|_warmer\|_warmers and /_alias\|_aliases\|_mapping\|_mappings\|_settings\|_warmer\|_warmers endpoints whilst maintaining the same response formats. The only exception to this is on the /_alias\|_aliases\|_warmer\|_warmers endpoint which will now return a section for 'aliases' or 'warmers' even if no aliases or warmers exist. This backwards compatibility change is documented in the reference docs. Closes #4069 2014-08-12 06:42:12 -04:00			`include::indices/get-index.asciidoc[]`

Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`include::indices/indices-exists.asciidoc[]`

			`include::indices/open-close.asciidoc[]`

			`include::indices/put-mapping.asciidoc[]`

			`include::indices/get-mapping.asciidoc[]`

Add a GetFieldMapping API This new API allows to get the mapping for a specific set of fields rather than get the whole index mapping and traverse it. The fields to be retrieved can be specified by their full path, index name and field name and will be resolved in this order. In case multiple field match, the first one will be returned. Since we are now generating the output (rather then fall back to the stored mapping), you can specify `include_defaults`=true on the request to have default values returned. Closes #3941 2013-10-14 02:53:07 -04:00			`include::indices/get-field-mapping.asciidoc[]`

Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`include::indices/types-exists.asciidoc[]`

			`include::indices/delete-mapping.asciidoc[]`

			`include::indices/aliases.asciidoc[]`

			`include::indices/update-settings.asciidoc[]`

			`include::indices/get-settings.asciidoc[]`

			`include::indices/analyze.asciidoc[]`

			`include::indices/templates.asciidoc[]`

			`include::indices/warmers.asciidoc[]`

			`include::indices/stats.asciidoc[]`

			`include::indices/segments.asciidoc[]`

Recovery API Adds a new API endpoint at /_recovery as well as to the Java API. The recovery API allows one to see the recovery status of all shards in the cluster. It will report on percent complete, recovery type, and which files are copied. Closes #4637 2014-02-18 17:28:49 -05:00			`include::indices/recovery.asciidoc[]`

Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`include::indices/clearcache.asciidoc[]`

			`include::indices/flush.asciidoc[]`

			`include::indices/refresh.asciidoc[]`

			`include::indices/optimize.asciidoc[]`

Add forgotten include for upgrade docs. See #7922 2014-10-10 13:55:45 -04:00			`include::indices/upgrade.asciidoc[]`