2019-03-21 12:11:38 -04:00
|
|
|
[role="xpack"]
|
|
|
|
[testenv="basic"]
|
2019-09-20 18:57:43 -04:00
|
|
|
[[delete-transform]]
|
2019-12-17 12:01:31 -05:00
|
|
|
=== Delete {transform} API
|
2019-04-30 13:46:13 -04:00
|
|
|
|
|
|
|
[subs="attributes"]
|
2019-03-21 12:11:38 -04:00
|
|
|
++++
|
2019-12-17 12:01:31 -05:00
|
|
|
<titleabbrev>Delete {transform}</titleabbrev>
|
2019-03-21 12:11:38 -04:00
|
|
|
++++
|
|
|
|
|
2019-09-16 11:28:19 -04:00
|
|
|
Deletes an existing {transform}.
|
2019-03-21 12:11:38 -04:00
|
|
|
|
2019-09-20 18:57:43 -04:00
|
|
|
[[delete-transform-request]]
|
2019-06-26 16:46:21 -04:00
|
|
|
==== {api-request-title}
|
2019-03-21 12:11:38 -04:00
|
|
|
|
2019-10-08 02:59:01 -04:00
|
|
|
`DELETE _transform/<transform_id>`
|
2019-03-21 12:11:38 -04:00
|
|
|
|
2019-09-20 18:57:43 -04:00
|
|
|
[[delete-transform-prereqs]]
|
2019-06-26 16:46:21 -04:00
|
|
|
==== {api-prereq-title}
|
2019-06-12 13:13:04 -04:00
|
|
|
|
2019-09-16 11:28:19 -04:00
|
|
|
* Before you can delete the {transform}, you must stop it.
|
2019-10-17 04:22:38 -04:00
|
|
|
* 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>>.
|
2019-03-21 12:11:38 -04:00
|
|
|
|
2019-06-26 16:46:21 -04:00
|
|
|
|
2019-09-20 18:57:43 -04:00
|
|
|
[[delete-transform-path-parms]]
|
2019-06-26 16:46:21 -04:00
|
|
|
==== {api-path-parms-title}
|
|
|
|
|
2019-09-16 11:28:19 -04:00
|
|
|
`<transform_id>`::
|
2019-12-17 12:01:31 -05:00
|
|
|
(Required, string)
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-id]
|
2019-07-10 17:39:38 -04:00
|
|
|
|
2019-09-20 18:57:43 -04:00
|
|
|
[[delete-transform-query-parms]]
|
2019-07-22 14:13:25 -04:00
|
|
|
==== {api-query-parms-title}
|
|
|
|
|
|
|
|
`force`::
|
2019-09-16 11:28:19 -04:00
|
|
|
(Optional, boolean) When `true`, the {transform} is deleted regardless of its
|
|
|
|
current state. The default value is `false`, meaning that the {transform} must be
|
2019-07-22 14:13:25 -04:00
|
|
|
`stopped` before it can be deleted.
|
2019-03-21 12:11:38 -04:00
|
|
|
|
2019-09-20 18:57:43 -04:00
|
|
|
[[delete-transform-examples]]
|
2019-06-27 12:42:47 -04:00
|
|
|
==== {api-examples-title}
|
2019-03-21 12:11:38 -04:00
|
|
|
|
2019-09-09 13:38:14 -04:00
|
|
|
[source,console]
|
2019-03-21 12:11:38 -04:00
|
|
|
--------------------------------------------------
|
2019-10-08 02:59:01 -04:00
|
|
|
DELETE _transform/ecommerce_transform
|
2019-03-21 12:11:38 -04:00
|
|
|
--------------------------------------------------
|
|
|
|
// TEST[skip:setup kibana sample data]
|
|
|
|
|
2019-09-16 11:28:19 -04:00
|
|
|
When the {transform} is deleted, you receive the following results:
|
2019-09-06 09:22:08 -04:00
|
|
|
|
|
|
|
[source,console-result]
|
2019-03-21 12:11:38 -04:00
|
|
|
----
|
|
|
|
{
|
|
|
|
"acknowledged" : true
|
|
|
|
}
|
|
|
|
----
|