elasticsearch/docs/reference/ingest/apis/delete-pipeline.asciidoc
Liam Thompson 33a71e3289
[DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413)
* Remove `es-test-dir` book-scoped variable

* Remove `plugins-examples-dir` book-scoped variable

* Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables

- In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed.
- In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path
- In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem

* Replace `es-repo-dir` with `es-ref-dir`

* Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
2024-04-17 14:37:07 +02:00

102 lines
1.7 KiB
Text

[[delete-pipeline-api]]
=== Delete pipeline API
++++
<titleabbrev>Delete pipeline</titleabbrev>
++++
Deletes one or more existing ingest pipeline.
////
[source,console]
----
PUT /_ingest/pipeline/my-pipeline-id
{
"description" : "example pipeline to delete",
"processors" : [ ]
}
PUT /_ingest/pipeline/pipeline-one
{
"description" : "another example pipeline to delete",
"processors" : [ ]
}
----
// TESTSETUP
////
[source,console]
----
DELETE /_ingest/pipeline/my-pipeline-id
----
[[delete-pipeline-api-request]]
==== {api-request-title}
`DELETE /_ingest/pipeline/<pipeline>`
[[delete-pipeline-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, you must have the
`manage_pipeline`, `manage_ingest_pipelines`, or `manage`
<<privileges-list-cluster,cluster privilege>> to use this API.
[[delete-pipeline-api-path-params]]
==== {api-path-parms-title}
`<pipeline>`::
+
--
(Required, string) Pipeline ID or wildcard expression of pipeline IDs
used to limit the request.
To delete all ingest pipelines in a cluster,
use a value of `*`.
--
[[delete-pipeline-api-query-params]]
==== {api-query-parms-title}
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[[delete-pipeline-api-api-example]]
==== {api-examples-title}
[[delete-pipeline-api-specific-ex]]
===== Delete a specific ingest pipeline
[source,console]
----
DELETE /_ingest/pipeline/pipeline-one
----
[[delete-pipeline-api-wildcard-ex]]
===== Delete ingest pipelines using a wildcard expression
[source,console]
----
DELETE /_ingest/pipeline/pipeline-*
----
[[delete-pipeline-api-all-ex]]
===== Delete all ingest pipelines
[source,console]
----
DELETE /_ingest/pipeline/*
----
////
[source,console-result]
----
{
"acknowledged": true
}
----
////