Get pipelines

GET /_ingest/pipeline/{id}
GET /_ingest/pipeline

Auth

Get information about one or more ingest pipelines. This API returns a local reference of the pipeline.

Path parameters

id string optional

Comma-separated list of pipeline IDs to retrieve. Wildcard (*) expressions are supported. To get all ingest pipelines, omit this parameter or use *.

Leave it out to use /_ingest/pipeline.

Query parameters

master_timeout union oneOf · default: 30s: 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.; Values: -1 0
summary boolean · default: false: Return pipelines without their definitions

Response

application/json

<string> object

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_ingest/pipeline/my-pipeline-id

JavaScript Elasticsearch JavaScript Client

const response = await client.ingest.getPipeline({
  id: "my-pipeline-id",
});

Python Elasticsearch Python Client

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

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_ingest/pipeline/my-pipeline-id" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ingest().getPipeline(g -> g
    .id("my-pipeline-id")
);

C# Elasticsearch .NET Client

var response = await client.Ingest
    .GetPipelineAsync(d1 => d1
        .Id("my-pipeline-id")
    );

PHP Elasticsearch PHP Client

$resp = $client->ingest()->getPipeline([
    "id" => "my-pipeline-id",
]);

Ruby Elasticsearch Ruby Client

response = client.ingest.get_pipeline(
  id: "my-pipeline-id"
)

Response

A successful response for retrieving information about an ingest pipeline.

{
  "my-pipeline-id" : {
    "description" : "describe pipeline",
    "version" : 123,
    "processors" : [
      {
        "set" : {
          "field" : "foo",
          "value" : "bar"
        }
      }
    ]
  }
}