Cancel a migration reindex operation

POST /_migration/reindex/{index}/_cancel

Auth

Cancel 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

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

Console Kibana Dev Tools

POST /_migration/reindex/my-data-stream/_cancel

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

client.indices().cancelMigrateReindex(c -> c
    .index("my-data-stream")
);

C# Elasticsearch .NET Client

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

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

{
  "acknowledged": false
}

Generated from the API spec