Stop 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.

Stops one or more data frame transforms.

Requestedit

POST _data_frame/transforms/<data_frame_transform_id>/_stop

POST _data_frame/transforms/<data_frame_transform_id1>,<data_frame_transform_id2>/_stop

POST _data_frame/transforms/_all/_stop

Descriptionedit

You can stop multiple data frame transforms in a single API request by using a comma-separated list of data frame transforms or a wildcard expression. All data frame transforms can be stopped by using _all or * as the <data_frame_transform_id>.

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.

Query Parametersedit

wait_for_completion
(boolean) If set to true, causes the API to block until the indexer state completely stops. If set to false, the API returns immediately and the indexer will be stopped asynchronously in the background. Defaults to false.
timeout
(time value) If wait_for_completion=true, the API blocks for (at maximum) the specified duration while waiting for the transform to stop. If more than timeout time has passed, the API throws a timeout exception. Even if a timeout exception is thrown, the stop request is still processing and eventually moves the transform to STOPPED. The timeout simply means the API call itself timed out while waiting for the status change. Defaults to 30s

Authorizationedit

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.

Examplesedit

The following example stops the ecommerce_transform data frame transform:

POST _data_frame/transforms/ecommerce_transform/_stop

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

{
  "acknowledged" : true
}