Delete transform API
editDelete transform API
editDeletes an existing transform.
Request
editDELETE _transform/<transform_id>
Prerequisites
edit-
Requires the
manage_transform
cluster privilege. This privilege is included in thetransform_admin
built-in role. - Before you can delete the transform, you must stop it.
Path parameters
edit-
<transform_id>
- (Required, string) Identifier for the transform.
Query parameters
edit-
force
-
(Optional, Boolean) When
true
, the transform is deleted regardless of its current state. The default value isfalse
, meaning that the transform must bestopped
before it can be deleted. -
delete_dest_index
-
(Optional, Boolean) When
true
, the destination index is deleted together with the transform. The default value isfalse
, meaning that the destination index will not be deleted. -
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
.
Examples
editresp = client.transform.delete_transform( transform_id="ecommerce_transform", ) print(resp)
response = client.transform.delete_transform( transform_id: 'ecommerce_transform' ) puts response
const response = await client.transform.deleteTransform({ transform_id: "ecommerce_transform", }); console.log(response);
DELETE _transform/ecommerce_transform
When the transform is deleted, you receive the following results:
{ "acknowledged" : true }