IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Update transforms API Get transforms API »

› › ›

Delete transforms API

edit

Delete transforms API

edit

Deletes an existing transform.

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Request

edit

DELETE _data_frame/transforms/<transform_id>

Prerequisites

edit

Before you can delete the transform, you must stop it.
If the Elasticsearch security features are enabled, you must have manage_data_frame_transforms cluster privileges to use this API. The built-in data_frame_transforms_admin role has these privileges. For more information, see Security privileges and Built-in roles.

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 is false, meaning that the transform must be stopped before it can be deleted.

Examples

edit

DELETE _data_frame/transforms/ecommerce_transform

When the transform is deleted, you receive the following results:

{
  "acknowledged" : true
}

« Update transforms API Get transforms API »