OpenSearch/docs/reference/ingest/apis/delete-pipeline.asciidoc

97 lines
1.5 KiB
Plaintext

[[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-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::{docdir}/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
}
----
////