IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Delete transform API
editDelete transform APIedit
Deletes an existing transform.
Requestedit
DELETE _transform/<transform_id>
Prerequisitesedit
-
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 parametersedit
-
<transform_id>
- (Required, string) Identifier for the transform.
Query parametersedit
-
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
.
Examplesedit
response = client.transform.delete_transform( transform_id: 'ecommerce_transform' ) puts response
DELETE _transform/ecommerce_transform
When the transform is deleted, you receive the following results:
{ "acknowledged" : true }