OpenSearch/docs/reference/data-frames/apis/delete-transform.asciidoc

63 lines
1.5 KiB
Plaintext
Raw Normal View History

[role="xpack"]
[testenv="basic"]
[[delete-data-frame-transform]]
=== Delete {dataframe-transforms} API
[subs="attributes"]
++++
<titleabbrev>Delete {dataframe-transforms}</titleabbrev>
++++
beta[]
Deletes an existing {dataframe-transform}.
[discrete]
[[delete-data-frame-transform-request]]
==== {api-request-title}
`DELETE _data_frame/transforms/<data_frame_transform_id>`
[discrete]
[[delete-data-frame-transform-prereqs]]
==== {api-prereq-title}
* 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].
[discrete]
[[delete-data-frame-transform-desc]]
==== {api-description-title}
NOTE: Before you can delete the {dataframe-transform}, you must stop it.
[discrete]
[[delete-data-frame-transform-path-parms]]
==== {api-path-parms-title}
`<data_frame_transform_id>` (Required)::
(string) Identifier for the {dataframe-transform}.
[discrete]
[[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,js]
----
{
"acknowledged" : true
}
----
// TESTRESPONSE