---
type: api
title: Index
description: Index APIs enable you to manage individual indices, index settings, aliases, mappings, and index templates.
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/group/endpoint-indices
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/group/endpoint-indices
products:
  - Elasticsearch
---

# Index

`indices`

Index APIs enable you to manage individual indices, index settings, aliases, mappings, and index templates.

[Learn more about indices.](https://www.elastic.co/docs/manage-data/data-store/index-basics)

- [Get component templates
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cluster-get-component-template): `GET` `/_component_template/{name}`, `GET` `/_component_template`
- [Create or update a component template
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template): `POST` (also `PUT`) `/_component_template/{name}`
- [Delete component templates](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cluster-delete-component-template): `DELETE` `/_component_template/{name}`
- [Check component templates](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cluster-exists-component-template): `HEAD` `/_component_template/{name}`
- [Import a dangling index](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-dangling-indices-import-dangling-index): `POST` `/_dangling/{index_uuid}`
- [Delete a dangling index](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-dangling-indices-delete-dangling-index): `DELETE` `/_dangling/{index_uuid}`
- [Get the dangling indices](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-dangling-indices-list-dangling-indices): `GET` `/_dangling`
- [Add an index block](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-add-block): `PUT` `/{index}/_block/{block}`
- [Remove an index block](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-remove-block): `DELETE` `/{index}/_block/{block}`
- [Get tokens from text analysis
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-analyze): `POST` (also `GET`) `/{index}/_analyze`, `POST` (also `GET`) `/_analyze`
- [Clear the cache
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-clear-cache): `POST` `/{index}/_cache/clear`, `POST` `/_cache/clear`
- [Clone an index
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-clone): `POST` (also `PUT`) `/{index}/_clone/{target}`
- [Close an index](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-close): `POST` `/{index}/_close`
- [Get index information](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-get): `GET` `/{index}`
- [Create an index](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-create): `PUT` `/{index}`
- [Delete indices](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-delete): `DELETE` `/{index}`
- [Check indices](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-exists): `HEAD` `/{index}`
- [Create or update an alias
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-put-alias): `POST` (also `PUT`) `/{index}/_aliases/{name}`, `POST` (also `PUT`) `/{index}/_alias/{name}`
- [Delete an alias
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-delete-alias): `DELETE` `/{index}/_aliases/{name}`, `DELETE` `/{index}/_alias/{name}`
- [Delete data stream lifecycles](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-delete-data-lifecycle): `DELETE` `/_data_stream/{name}/_lifecycle`
- [Get index templates
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-get-index-template): `GET` `/_index_template/{name}`, `GET` `/_index_template`
- [Create or update an index template
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-put-index-template): `POST` (also `PUT`) `/_index_template/{name}`
- [Delete an index template](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-delete-index-template): `DELETE` `/_index_template/{name}`
- [Check index templates](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-exists-index-template): `HEAD` `/_index_template/{name}`
- [Get legacy index templates
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-get-template): `GET` `/_template/{name}`, `GET` `/_template`
- [Create or update a legacy index template
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-put-template): `POST` (also `PUT`) `/_template/{name}`
- [Delete a legacy index template](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-delete-template): `DELETE` `/_template/{name}`
- [Check existence of index templates](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-exists-template): `HEAD` `/_template/{name}`
- [Analyze the index disk usage](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-disk-usage): `POST` `/{index}/_disk_usage`
- [Get aliases
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-get-alias): `GET` `/{index}/_alias/{name}`, `GET` `/{index}/_alias`, `GET` `/_alias/{name}`, `GET` `/_alias`
- [Check aliases
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-exists-alias): `HEAD` `/{index}/_alias/{name}`, `HEAD` `/_alias/{name}`
- [Get field usage stats](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-field-usage-stats): `GET` `/{index}/_field_usage_stats`
- [Flush data streams or indices
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-flush): `POST` (also `GET`) `/{index}/_flush`, `POST` (also `GET`) `/_flush`
- [Force a merge
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-forcemerge): `POST` `/{index}/_forcemerge`, `POST` `/_forcemerge`
- [Get mapping definitions
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-get-field-mapping): `GET` `/{index}/_mapping/field/{fields}`, `GET` `/_mapping/field/{fields}`
- [Get mapping definitions
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-get-mapping): `GET` `/{index}/_mapping`, `GET` `/_mapping`
- [Update field mappings
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-put-mapping): `POST` (also `PUT`) `/{index}/_mapping`
- [Get index settings
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-get-settings): `GET` `/{index}/_settings/{name}`, `GET` `/{index}/_settings`, `GET` `/_settings/{name}`, `GET` `/_settings`
- [Open a closed index](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-open): `POST` `/{index}/_open`
- [Update index settings
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-put-settings): `PUT` `/{index}/_settings`, `PUT` `/_settings`
- [Get index recovery information
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-recovery): `GET` `/{index}/_recovery`, `GET` `/_recovery`
- [Refresh an index
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-refresh): `POST` (also `GET`) `/{index}/_refresh`, `POST` (also `GET`) `/_refresh`
- [Reload search analyzers
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-reload-search-analyzers): `POST` (also `GET`) `/{index}/_reload_search_analyzers`
- [Resolve the cluster
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-resolve-cluster): `GET` `/_resolve/cluster/{name}`, `GET` `/_resolve/cluster`
- [Resolve indices
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-resolve-index): `POST` (also `GET`) `/_resolve/index/{name}`
- [Roll over to a new index
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-rollover): `POST` `/{alias}/_rollover/{new_index}`, `POST` `/{alias}/_rollover`
- [Get index segments
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-segments): `GET` `/{index}/_segments`, `GET` `/_segments`
- [Get index shard stores
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-shard-stores): `GET` `/{index}/_shard_stores`, `GET` `/_shard_stores`
- [Shrink an index
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-shrink): `POST` (also `PUT`) `/{index}/_shrink/{target}`
- [Simulate an index](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-simulate-index-template): `POST` `/_index_template/_simulate_index/{name}`
- [Simulate an index template
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-simulate-template): `POST` `/_index_template/_simulate/{name}`, `POST` `/_index_template/_simulate`
- [Split an index
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-split): `POST` (also `PUT`) `/{index}/_split/{target}`
- [Get index statistics
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-stats): `GET` `/{index}/_stats/{metric}`, `GET` `/_stats/{metric}`, `GET` `/{index}/_stats`, `GET` `/_stats`
- [Create or update an alias](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-update-aliases): `POST` `/_aliases`
- [Validate a query
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-validate-query): `POST` (also `GET`) `/{index}/_validate/query`, `POST` (also `GET`) `/_validate/query`