Reset transform APIedit
Resets a transform.
Requestedit
POST _transform/<transform_id>/_reset
Prerequisitesedit
-
Requires the
manage_transformcluster privilege. This privilege is included in thetransform_adminbuilt-in role.
Descriptionedit
Before you can reset the transform, you must stop it; alternatively, use the
force query parameter.
If you reset a transform, all checkpoints, states, and the destination index (if it was created by the transform) are deleted. The transform is updated to the latest format as if the Update transform API was used. The transform is ready to start again as if it had just been created.
Path parametersedit
-
<transform_id> - (Required, string) Identifier for the transform.
Query parametersedit
-
force -
(Optional, Boolean)
If this value is
true, the transform is reset regardless of its current state. If it’s false, the transform must bestoppedbefore it can be reset. The default value isfalse -
timeout -
(Optional, time)
Period to wait for a response. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to
30s.
Examplesedit
POST _transform/ecommerce_transform/_reset
When the transform is reset, you receive the following results:
{
"acknowledged" : true
}