Get pipelines

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

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

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Response

application/json

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"
        }
      }
    ]
  }
}