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

« Create transform API Get transforms API »

› › ›

Delete transform API

edit

Delete transform API

edit

Deletes an existing transform.

Request

edit

DELETE _transform/<transform_id>

Prerequisites

edit

Requires the manage_transform cluster privilege. This privilege is included in the transform_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. 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

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 _transform/ecommerce_transform

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

{
  "acknowledged" : true
}

« Create transform API Get transforms API »