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

60 lines
1.4 KiB
Plaintext
Raw Normal View History

[role="xpack"]
[testenv="basic"]
[[delete-transform]]
=== Delete {transform} API
[subs="attributes"]
++++
<titleabbrev>Delete {transform}</titleabbrev>
++++
Deletes an existing {transform}.
[[delete-transform-request]]
==== {api-request-title}
`DELETE _transform/<transform_id>`
[[delete-transform-prereqs]]
==== {api-prereq-title}
* Before you can delete the {transform}, you must stop it.
* If the {es} {security-features} are enabled, you must have `manage_transform`
cluster privileges to use this API. The built-in `transform_admin` role has
these privileges. For more information, see <<security-privileges>> and
<<built-in-roles>>.
[[delete-transform-path-parms]]
==== {api-path-parms-title}
`<transform_id>`::
(Required, string)
include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-id]
[[delete-transform-query-parms]]
==== {api-query-parms-title}
`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.
[[delete-transform-examples]]
==== {api-examples-title}
[source,console]
--------------------------------------------------
DELETE _transform/ecommerce_transform
--------------------------------------------------
// TEST[skip:setup kibana sample data]
When the {transform} is deleted, you receive the following results:
[source,console-result]
----
{
"acknowledged" : true
}
----