PUT /_create_from/<source>/<dest>

POST/_create_from/<source>/<dest>

• If the Elasticsearch security features are enabled, you must have themanageindex privilege for the index.

This api allows you to add a new index to an Elasticsearch cluster, using an existing source index as a basis for the new index. The settings and mappings from the source index will copied over to the destination index. You can also provide override settings and mappings which will be combined with the source settings and mappings when creating the destination index.

<source>

(Required, string) Name of the existing source index which will be used as a basis.

<dest>

(Required, string) Name of the destination index which will be created.

settings_override

(Optional, index setting object)Index settings which override the source settings.

mappings_override

(Optional,mapping object) Mappings which override the source mappings.

remove_index_blocks

(Optional, boolean) Filter out any index blocks from the source index when creating the destination index. Defaults totrue.

Start by creating a source index that we’ll copy using this API.

PUT /my-index{  "settings": {    "index": {      "number_of_shards": 3,      "blocks.write": true    }  },  "mappings": {    "properties": {        "field1": { "type": "text" }    }  }}

Now we create a destination index from the source index. This new index will have the same mappings and settings as the source index.

POST _create_from/my-index/my-new-index

Alternatively, we could override some of the source’s settings and mappings. This will use the source settings and mappings as a basis and combine these with the overrides to create the destination settings and mappings.

POST _create_from/my-index/my-new-index{  "settings_override": {    "index": {      "number_of_shards": 5    }  },  "mappings_override": {    "properties": {        "field2": { "type": "boolean" }    }  }}

Since the destination index is empty, we very likely will want to write into the index after creation. This would not be possible if the source index contains anindex write block which is copied over to the destination index. One way to handle this is to remove the index write block using a settings override. For example, the following settings override removes all index blocks.

POST _create_from/my-index/my-new-index{  "settings_override": {    "index": {      "blocks.write": null,      "blocks.read": null,      "blocks.read_only": null,      "blocks.read_only_allow_delete": null,      "blocks.metadata": null    }  }}

Since this is a common scenario, index blocks are actually removed by default. This is controlled with the parameterremove_index_blocks, which defaults totrue. If we want the destination index to contains the index blocks from the source index, we can do the following:

POST _create_from/my-index/my-new-index{  "remove_index_blocks": false}