Reindex legacy backing indices

POST /_migration/reindex

Auth

Reindex all legacy backing indices for a data stream. This operation occurs in a persistent task. The persistent task ID is returned immediately and the reindexing work is completed in that task.

About reindexing data streams

Required privileges

Index privileges manage

Request body

mode enum required: Reindex mode. Currently only 'upgrade' is supported.; Values: upgrade
source object required: The source index or data stream (only data streams are currently supported).

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

View as Markdown

Examples

Request Console 1 / 8 languages

An example body for a POST _migration/reindex request.

Console Kibana Dev Tools

POST _migration/reindex
{
    "source": {
        "index": "my-data-stream"
    },
    "mode": "upgrade"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.migrateReindex({
  reindex: {
    source: {
      index: "my-data-stream",
    },
    mode: "upgrade",
  },
});

Python Elasticsearch Python Client

resp = client.indices.migrate_reindex(
    reindex={
        "source": {
            "index": "my-data-stream"
        },
        "mode": "upgrade"
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_migration/reindex" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "source": {
      "index": "my-data-stream"
    },
    "mode": "upgrade"
  }'

Java Elasticsearch Java Client

client.indices().migrateReindex(m -> m
    .reindex(r -> r
        .mode(ModeEnum.Upgrade)
        .source(s -> s
            .index("my-data-stream")
        )
    )
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .MigrateReindexAsync(d1 => d1
        .Reindex(d2 => d2
            .Mode(ModeEnum.Upgrade)
            .Source(d3 => d3
                .Index("my-data-stream")
            )
        )
    );

PHP Elasticsearch PHP Client

$requestFactory = Psr17FactoryDiscovery::findRequestFactory();
$streamFactory = Psr17FactoryDiscovery::findStreamFactory();
$request = $requestFactory->createRequest(
    "POST",
    "/_migration/reindex",
);
$request = $request->withHeader("Content-Type", "application/json");
$request = $request->withBody($streamFactory->createStream(
    json_encode([
        "source" => [
            "index" => "my-data-stream",
        ],
        "mode" => "upgrade",
    ]),
));
$resp = $client->sendRequest($request);

Ruby Elasticsearch Ruby Client

response = client.indices.migrate_reindex(
  body: {
    "source": {
      "index": "my-data-stream"
    },
    "mode": "upgrade"
  }
)

Response

{
  "acknowledged": false
}

Generated from the API spec

Required privileges

Request body { }

Response

Request body