Elasticsearch Reindex
ElasticOfficialCreated by elastic
- Skill
- Tool integration
- Software development
- Apache-2.0
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides a structured workflow for copying or migrating data between Elasticsearch indices. It covers critical aspects of the reindex process, including environment verification, destination preparation, performance tuning, and task management. It emphasizes best practices such as using asynchronous task execution for large jobs, applying filters to limit data scope, and verifying results through document counts. The skill is designed to help users navigate the differences between self-managed, Elastic Cloud Hosted, and Serverless deployment environments.
What it does
- Guides the preparation of destination indices with correct mappings and settings.
- Facilitates local and remote cluster data migration.
- Provides methods for filtering data subsets during the reindex process.
- Supports performance optimization via slicing, throttling, and batch sizing.
- Enables asynchronous task tracking and management.
- Ensures data integrity through post-reindex count verification.
When to use it
- When you need to change field mappings or analyzers on an existing index.
- When migrating data between different Elasticsearch clusters.
- When you need to transform data during the copy process.
- When you need to copy a specific subset of data based on time ranges or other filters.
- When consolidating indices or data streams.
Advantages
- Reduces risk of partial failures by enforcing explicit destination preparation.
- Improves performance for large datasets using parallel slicing and throttling.
- Provides clear guidance on deployment-specific constraints.
- Minimizes downtime by supporting alias swaps and asynchronous background tasks.
Usage examples
- “How do I reindex a large index named events into events-v2 while throttling the speed?”
- The agent will provide the POST /_reindex command with slices=auto and a specified requests_per_second parameter to manage cluster load.
- “I need to migrate only the logs from January 2025 from my metrics index.”
- The agent will guide you to create a destination index and use a source query with a range filter on the @timestamp field.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/elastic/elasticsearch-reindex/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip elasticsearch-reindex.zip -d .agents/skills
Documentation by elastic
Elasticsearch Reindex
Copy documents from source indices or data streams to a destination using POST /_reindex. An expert reindex workflow
prepares the destination explicitly, chooses local versus remote execution, filters at the source when only a subset is
needed, runs long copies asynchronously, tracks the task to completion, and verifies the destination document count
before reporting results.
<!-- begin-partial: preamble -->
Environment Configuration
This skill executes Elasticsearch operations through the elastic CLI. If the
elastic CLI is not installed, tell the user what it is needed for. Do
not guess credentials, call the HTTP API directly, or attempt other workarounds.
This skill references operations in HTTP-shorthand form (e.g., GET /, GET /_cat/indices, GET /{index}/_mapping,
GET /{index}/_settings/index.mode, POST /_query). The Operations table at the end of this document
maps each shorthand to the equivalent elastic CLI command — always use the CLI rather than calling the HTTP API
directly.
<!-- end-partial: preamble -->
Process
Confirm connectivity and deployment type. Call
GET /. Readbuild_flavorandversion.numberto know whether shard, replica, and cluster-settings APIs are available (Serverless manages shards/replicas internally and blocks most_cluster/*APIs). The decision: continue only when the cluster is reachable. If the call fails, stop — do not guess endpoints or credentials.Decide local versus remote reindex. Compare where the source and destination live.
Same cluster — use local reindex:
source.indexanddest.indexonly. Do not addsource.remotewhen both indices are on the cluster you are connected to.Different cluster — use reindex from remote: add
source.remotewith the remote cluster URL and credentials. Remote reindex does not support slicing; compensate with query-based partitioning (date ranges, term filters) across parallel requests. Confirm the remote host is allowlisted on Self-Managed / ECH (reindex.remote.whitelistin cluster config); Serverless manages allowlisting internally (ECH remotes only, Tech Preview).
Data needed: source index name(s), destination index name, and whether they share a cluster.
Inspect the source — never guess field names or counts. Call
GET /{source}/_mappingto ground field names and types. CallGET /{source}/_count(orGET /_cat/count/{source}?h=counton Self-Managed / ECH) to learn how many documents exist.The decision: full copy versus filtered subset.
Full copy — omit
source.query(match-all behavior).Filtered subset — add
source.querywith Query DSL. For time ranges, use arangefilter on the timestamp field (commonly@timestamp), e.g."gte": "2025-01-01", "lt": "2025-02-01"for January 2025. Do not run a full-index copy when the user asked for a date range or other filter.
Data needed: the user's filter criteria and the mapping-confirmed field names.
Prepare the destination index before copying.
_reindexdoes not copy mappings, shard counts, or analyzers. Create the destination with explicit settings and mappings derived from the source mapping viaPUT /{dest}.On Self-Managed / ECH: set
number_of_replicas: 0andrefresh_interval: "-1"on the destination during the copy for write throughput; restore production values afterward withPUT /{dest}/_settings.On Serverless: omit
number_of_shardsandnumber_of_replicas(managed by Elastic); you may setrefresh_interval: "-1"during the copy.For data stream destinations: ensure an index template with
data_stream: {}exists, create the data stream, and setdest.op_typeto"create"(append-only).
The decision: create/prepare the target rather than relying on auto-creation with dynamic mapping. Wrong or missing mappings cause partial failures or silent type coercion.
Data needed: destination name, corrected or compatible mappings, and deployment-specific settings constraints.
Build and submit the reindex request. Call
POST /_reindex?wait_for_completion=falsefor any copy that may take more than a few seconds or when the user says the index is large — the response returns a task id immediately instead of blocking.Request body essentials:
source.index— source index or data stream (correct name, not reversed withdest.index).dest.index— prepared destination from step 4.source.query— include only when step 3 chose a filtered subset.conflicts: "proceed"— when retrying a partially complete reindex.Optional tuning:
source.size(batch size),requests_per_second(throttle),slices=autoon local reindex only (parallelize per primary shard — never for remote),scroll(increase keep-alive on slow clusters),max_docs(test runs),script(transform),dest.pipeline(ingest enrichment).
Example filtered subset (January 2025 only):
{ "source": { "index": "eval-reindex-src", "query": { "range": { "@timestamp": { "gte": "2025-01-01", "lt": "2025-02-01" } } } }, "dest": { "index": "eval-reindex-jan" } }Do not reach for
_split,_shrink, or snapshot/restore when the task is a filtered subset copy or a straight document migration — those APIs solve different problems.Track the task to completion. Store the task id from the reindex response. Poll
GET /_tasks/{task_id}untilcompletedistrue. Readstatus.total,status.created, andresponse.failures. On Self-Managed / ECH you may also list active reindex tasks withGET /_tasks?actions=*reindex&detailed; on Serverless, query by task id only (list/cancel are not available). Adjust throttling mid-flight withPOST /_reindex/{task_id}/_rethrottle?requests_per_second=Nwithout canceling.Verify and report the destination count. Call
GET /{dest}/_count(works on all deployment types). On Self-Managed / ECH you may also useGET /_cat/count/{dest}?h=count. Compare source filter expectations to the destination count. Report the exact count from the destination — do not estimate or guess.After a successful full copy, restore production settings on the destination with
PUT /{dest}/_settings(replicas and refresh interval on Self-Managed / ECH; refresh interval only on Serverless).
Deployment constraints
| Capability | Self-Managed / ECH | Serverless |
|---|---|---|
| Local reindex | Full support | Full support |
| Reindex from remote | Full support | Tech Preview — ECH remotes only |
number_of_shards/replicas | User-configurable | Managed — omit on index creation |
slices=auto (local only) | Supported | Supported for local reindex |
GET /_cat/count/{index} | Supported | Not available — use GET /{index}/_count |
GET /_tasks (list/cancel) | Full | Get by task id only |
PUT /_cluster/settings | Supported | Blocked |
_split / _shrink | Supported | Not available |
Consider alternatives first
Runtime fields — fix field-type mismatches or add computed fields without reindexing when stored values need not change.
Aliases — redirect queries transparently; combine with reindex for zero-downtime mapping changes.
Snapshot and restore (Self-Managed / ECH) — faster whole-index transfer when no transformation is needed.
See the decision tree in references/patterns.md.
Reference material
API parameter reference — full
POST /_reindexbody and query parametersMulti-step patterns — mapping changes, remote migration, merge, ingest pipeline, performance
Tuning — batch size (
source.size), timestamps, versioningTroubleshooting — mapping conflicts, scroll timeouts, count mismatches
Examples
"Copy logs-2024 into a new index with a corrected mapping" — create the destination first, then reindex:
POST /_reindex
{ "source": { "index": "logs-2024" }, "dest": { "index": "logs-2024-v2" } }"Reindex a large index in parallel and throttle it" — slice automatically and cap the request rate:
POST /_reindex?slices=auto&requests_per_second=2000
{ "source": { "index": "events" }, "dest": { "index": "events-v2" } }"Migrate only recent documents" — filter the source with a query:
POST /_reindex
{
"source": { "index": "metrics", "query": { "range": { "@timestamp": { "gte": "now-30d" } } } },
"dest": { "index": "metrics-recent" }
}Guidelines
Confirm deployment type first. Call
GET /and readbuild_flavor; shard, replica, cluster-settings, and task APIs differ between Self-Managed / ECH and Serverless (see Deployment constraints).Prefer an alternative when it fits. Runtime fields, aliases, or snapshot-and-restore often avoid a full reindex.
Tune the destination for the copy. On Self-Managed / ECH set
number_of_replicas: 0andrefresh_interval: "-1"during the copy, then restore production settings afterward; on Serverless these are managed.Parallelize large copies. Use
slices=autofor local reindex and throttle withrequests_per_secondto protect the cluster.Run big jobs asynchronously. Submit with
wait_for_completion=falseand poll the task instead of blocking.Verify by count. Compare the source filter expectation to the exact destination
GET /{dest}/_count— never estimate.
Operations
| HTTP API (shorthand) | elastic CLI command |
|---|---|
GET / | elastic es info |
GET /{index}/_mapping | elastic es indices get-mapping --index '<index>' |
GET /{index}/_count | elastic es count --index '<index>' |
GET /_cat/count/{index}?h=count | elastic es cat count --index '<index>' --h count |
PUT /{index} | elastic es indices create --index '<index>' --mappings '<json>' --settings '<json>' |
PUT /{index}/_settings | elastic es indices put-settings --index '<index>' --settings '<json>' |
POST /_reindex?wait_for_completion=false | elastic es reindex --wait-for-completion false --source '<json>' --dest '<json>' |
GET /_tasks/{task_id} | elastic es tasks get --task-id '<task_id>' |
GET /_tasks?actions=*reindex&detailed | elastic es tasks list --actions '*reindex' --detailed |
POST /_tasks/{task_id}/_cancel | elastic es tasks cancel --task-id '<task_id>' |
POST /_reindex/{task_id}/_rethrottle?requests_per_second=N | elastic es reindex-rethrottle --task-id '<task_id>' --requests-per-second <N> |
Files
- ATTRIBUTION.mdAdded by AutoGineer986 B
- LICENSELicence file added by AutoGineer11.1 KiB
- SKILL.md12.6 KiB
- references/api-reference.md14.2 KiB
- references/patterns.md15.5 KiB
- references/troubleshooting.md2.4 KiB
- references/tuning.md2.8 KiB
LICENSE
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2026 Elasticsearch BV
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
The author says: Elasticsearch 8.x or 9.x, self-managed, Elastic Cloud Hosted, or Elastic Cloud Serverless; local reindex works on all deployment types, while remote reindex requires host allowlisting on self-managed / Elastic Cloud Hosted (Serverless supports Elastic Cloud Hosted remotes only, Tech Preview). Requires the `elastic` CLI ≥ 0.2 with `stack es` support.
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- elastic
- Publisher
- Elastic (Official)
- Source
- elastic/agent-skills · skills/elasticsearch/elasticsearch-reindex · commit 09d879d
- Licence
- Apache License 2.0 (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
- Also distributed in
- elastic/agent-skills
AutoGineer is not affiliated with or endorsed by elastic or Elastic.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download elasticsearch-reindex.zip