Start data frame transforms APIedit

Warning

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.

Starts one or more data frame transforms.

Requestedit

POST _data_frame/transforms/<data_frame_transform_id>/_start

Path Parametersedit

data_frame_transform_id (required)
(string) Identifier for the data frame transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.

Authorizationedit

If the Elasticsearch security features are enabled, you must have manage_data_frame_transforms cluster privileges to use this API. You must also have view_index_metadata privileges on the source index for the data frame transform. For more information, see Security privileges and Built-in roles.

Examplesedit

The following example starts the ecommerce_transform data frame transform:

POST _data_frame/transforms/ecommerce_transform/_start

When the data frame transform starts, you receive the following results:

{
  "acknowledged" : true
}