Delete transform API

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

DELETE _transform/<transform_id>

Prerequisites

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

Path parameters

<transform_id>
(Required, string) Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.

Query parameters

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

DELETE _transform/ecommerce_transform

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

{
  "acknowledged" : true
}