This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Get pipeline API Simulate pipeline API »

› › ›

Delete pipeline API

edit

Delete pipeline API

edit

Deletes one or more existing ingest pipeline.

resp = client.ingest.delete_pipeline(
    id="my-pipeline-id",
)
print(resp)

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

const response = await client.ingest.deletePipeline({
  id: "my-pipeline-id",
});
console.log(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 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.

Examples

edit

Delete a specific ingest pipeline

edit

resp = client.ingest.delete_pipeline(
    id="pipeline-one",
)
print(resp)

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

const response = await client.ingest.deletePipeline({
  id: "pipeline-one",
});
console.log(response);

DELETE /_ingest/pipeline/pipeline-one

Delete ingest pipelines using a wildcard expression

edit

resp = client.ingest.delete_pipeline(
    id="pipeline-*",
)
print(resp)

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

const response = await client.ingest.deletePipeline({
  id: "pipeline-*",
});
console.log(response);

DELETE /_ingest/pipeline/pipeline-*

Delete all ingest pipelines

edit

resp = client.ingest.delete_pipeline(
    id="*",
)
print(resp)

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

const response = await client.ingest.deletePipeline({
  id: "*",
});
console.log(response);

DELETE /_ingest/pipeline/*

« Get pipeline API Simulate pipeline API »