IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Create or update pipeline API GeoIP stats API »

› › ›

Delete pipeline API

edit

Delete pipeline API

edit

Deletes one or more existing ingest pipeline.

response = client.ingest.delete_pipeline(
  id: 'my-pipeline-id'
)
puts response

DELETE /_ingest/pipeline/my-pipeline-id

Request

edit

DELETE /_ingest/pipeline/<pipeline>

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the manage_pipeline, manage_ingest_pipelines, or manage cluster privilege to use this API.

Path parameters

edit

<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 parameters

edit

master_timeout: (Optional, time units) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
timeout: (Optional, time units) 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.

Examples

edit

Delete a specific ingest pipeline

edit

response = client.ingest.delete_pipeline(
  id: 'pipeline-one'
)
puts response

DELETE /_ingest/pipeline/pipeline-one

Delete ingest pipelines using a wildcard expression

edit

response = client.ingest.delete_pipeline(
  id: 'pipeline-*'
)
puts response

DELETE /_ingest/pipeline/pipeline-*

Delete all ingest pipelines

edit

response = client.ingest.delete_pipeline(
  id: '*'
)
puts response

DELETE /_ingest/pipeline/*

« Create or update pipeline API GeoIP stats API »