Reset a transform

POST /_transform/{transform_id}/_reset

Before you can reset it, you must stop it; alternatively, use the force query parameter. If the destination index was created by the transform, it is deleted.

Required authorization

Authentication

Authorization: <value>

Elasticsearch APIs use 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}"

For more information about where to find API keys for the Elasticsearch endpoint (${ES_URL}) for a project, go to Get started with Elasticsearch Serverless.

Path parameters

Query parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _transform/ecommerce_transform/_reset

JavaScript Elasticsearch JavaScript Client

const response = await client.transform.resetTransform({
  transform_id: "ecommerce_transform",
});

Python Elasticsearch Python Client

resp = client.transform.reset_transform(
    transform_id="ecommerce_transform",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_transform/ecommerce_transform/_reset" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.transform().resetTransform(r -> r
    .transformId("ecommerce_transform")
);

C# Elasticsearch .NET Client

var response = await client.TransformManagement.ResetTransformAsync(transformId: "ecommerce_transform");

PHP Elasticsearch PHP Client

$resp = $client->transform()->resetTransform([
    "transform_id" => "ecommerce_transform",
]);

Ruby Elasticsearch Ruby Client

response = client.transform.reset_transform(
  transform_id: "ecommerce_transform"
)

Response

A successful response when the transform is reset.

{
  "acknowledged": true
}