Get the migration reindexing status

GET /_migration/reindex/{index}/_status

Auth

Get the status of a migration reindex attempt for a data stream or index.

Required privileges

Index privileges manage

Path parameters

index union string | string[] required: The index or data stream name.

Response

application/json

start_time union oneOf: One of: string or number
start_time_millis number required
complete boolean required
total_indices_in_data_stream number required
total_indices_requiring_upgrade number required
successes number required
in_progress object[] required
pending number required
errors object[] required
exception string

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_migration/reindex/my-data-stream/_status

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.getMigrateReindexStatus({
  index: "my-data-stream",
});

Python Elasticsearch Python Client

resp = client.indices.get_migrate_reindex_status(
    index="my-data-stream",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_migration/reindex/my-data-stream/_status" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().getMigrateReindexStatus(g -> g
    .index("my-data-stream")
);

C# Elasticsearch .NET Client

var response = await client.Indices.GetMigrateReindexStatusAsync(indices: new[] { "my-data-stream" });

PHP Elasticsearch PHP Client

$requestFactory = Psr17FactoryDiscovery::findRequestFactory();
$request = $requestFactory->createRequest(
    "GET",
    "/_migration/reindex/my-data-stream/_status",
);
$resp = $client->sendRequest($request);

Ruby Elasticsearch Ruby Client

response = client.indices.get_migrate_reindex_status(
  index: "my-data-stream"
)

Response

{
  "start_time": "string",
  "start_time_millis": 0,
  "complete": false,
  "total_indices_in_data_stream": 0,
  "total_indices_requiring_upgrade": 0,
  "successes": 0,
  "in_progress": [
    {
      "index": "string",
      "total_doc_count": 0,
      "reindexed_doc_count": 0
    }
  ],
  "pending": 0,
  "errors": [
    {
      "index": "string",
      "message": "string"
    }
  ],
  "exception": "string"
}

Generated from the API spec