Cancel a migration reindex operation

POST /_migration/reindex/{index}/_cancel

Cancel a migration reindex attempt for a data stream or index.

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Response

application/json

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

No example