Reset a transform

POST /_transform/{transform_id}/_reset

Auth

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 privileges

Cluster privileges manage_transform

Path parameters

transform_id string required: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters.

Query parameters

force boolean · default: false: If this value is true, the transform is reset regardless of its current state. If it's false, the transform must be stopped before it can be reset.
timeout union oneOf · default: 30s: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.; Values: -1 0

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 _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
}