1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465 |
- [role="xpack"]
- [[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}
- * Requires the `manage_transform` cluster privilege. This privilege is included
- in the `transform_admin` built-in role.
- * Before you can delete the {transform}, you must stop it.
- [[delete-transform-path-parms]]
- == {api-path-parms-title}
- `<transform_id>`::
- (Required, string)
- include::{es-repo-dir}/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_dest_index`::
- (Optional, Boolean) When `true`, the destination index is deleted together with
- the {transform}. The default value is `false`, meaning that the destination
- index will not be deleted.
- `timeout`::
- (Optional, time)
- Period to wait for a response. If no response is received before the timeout
- expires, the request fails and returns an error. Defaults to `30s`.
- [[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
- }
- ----
|