1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162 |
- [role="xpack"]
- [testenv="basic"]
- [[delete-data-frame-transform]]
- === Delete {dataframe-transforms} API
- [subs="attributes"]
- ++++
- <titleabbrev>Delete {dataframe-transforms}</titleabbrev>
- ++++
- Deletes an existing {dataframe-transform}.
- beta[]
- [[delete-data-frame-transform-request]]
- ==== {api-request-title}
- `DELETE _data_frame/transforms/<data_frame_transform_id>`
- [[delete-data-frame-transform-prereqs]]
- ==== {api-prereq-title}
- * Before you can delete the {dataframe-transform}, you must stop it.
- * If the {es} {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 {stack-ov}/security-privileges.html[Security privileges] and
- {stack-ov}/built-in-roles.html[Built-in roles].
- [[delete-data-frame-transform-path-parms]]
- ==== {api-path-parms-title}
- `<data_frame_transform_id>`::
- (Required, string) Identifier for the {dataframe-transform}.
- [[delete-data-frame-transform-query-parms]]
- ==== {api-query-parms-title}
- `force`::
- (Optional, boolean) When `true`, the {dataframe-transform} is deleted regardless of its
- current state. The default value is `false`, meaning that the {dataframe-transform} must be
- `stopped` before it can be deleted.
- [[delete-data-frame-transform-examples]]
- ==== {api-examples-title}
- [source,js]
- --------------------------------------------------
- DELETE _data_frame/transforms/ecommerce_transform
- --------------------------------------------------
- // CONSOLE
- // TEST[skip:setup kibana sample data]
- When the {dataframe-transform} is deleted, you receive the following results:
- [source,console-result]
- ----
- {
- "acknowledged" : true
- }
- ----
|