You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Delete pipeline APIedit
Deletes one or more existing ingest pipeline.
response = client.ingest.delete_pipeline( id: 'my-pipeline-id' ) puts response
DELETE /_ingest/pipeline/my-pipeline-id
Requestedit
DELETE /_ingest/pipeline/<pipeline>
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
manage_pipeline
,manage_ingest_pipelines
, ormanage
cluster privilege to use this API.
Path parametersedit
-
<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
*
.
Query parametersedit
-
master_timeout
-
(Optional, time units)
Period to wait for the master node. If the master node is not available before
the timeout expires, the request fails and returns an error. Defaults to
30s
. Can also be set to-1
to indicate that the request should never timeout. -
timeout
-
(Optional, time units)
Period to wait for a response from all relevant nodes in the cluster after
updating the cluster metadata. If no response is received before the timeout
expires, the cluster metadata update still applies but the response will
indicate that it was not completely acknowledged. Defaults to
30s
. Can also be set to-1
to indicate that the request should never timeout.
Examplesedit
Delete a specific ingest pipelineedit
response = client.ingest.delete_pipeline( id: 'pipeline-one' ) puts response
DELETE /_ingest/pipeline/pipeline-one
Delete ingest pipelines using a wildcard expressionedit
response = client.ingest.delete_pipeline( id: 'pipeline-*' ) puts response
DELETE /_ingest/pipeline/pipeline-*
Delete all ingest pipelinesedit
response = client.ingest.delete_pipeline( id: '*' ) puts response
DELETE /_ingest/pipeline/*