---
type: api
title: Get pipelines
description: **All methods and paths for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/operation/operation-ingest-get-pipeline
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/operation/operation-ingest-get-pipeline
products:
  - Elasticsearch
---

# Get pipelines


Availability: Generally available since 5.0

## Paths

- `GET` `/_ingest/pipeline/{id}`
- `GET` `/_ingest/pipeline`

#### Path parameters

- `id` (string) — optional, leave it out to use `/_ingest/pipeline`
  Comma-separated list of pipeline IDs to retrieve.
Wildcard (`*`) expressions are supported.
To get all ingest pipelines, omit this parameter or use `*`.

## Description

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

[About ingest pipelines](https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines)

## 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](https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/token-based-authentication-services)

## Query string parameters

- `master_timeout` (string · default: 30s) — optional
  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.
- `summary` (boolean · default: false) — optional
  Return pipelines without their definitions

## Response

`application/json`

- `<string>` (object)
  - `description` (string)
    Description of the ingest pipeline.
  - `on_failure` ({} Processor[])
    Processors to run immediately after a processor failure.
    See [Processor](https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/types/ingest-_types-processorcontainer)
  - `processors` ({} Processor[])
    Processors used to perform transformations on documents before indexing.
Processors run sequentially in the order specified.
    See [Processor](https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/types/ingest-_types-processorcontainer)
  - `version` (number)
    Version number used by external systems to track ingest pipelines.
  - `deprecated` (boolean · default: false)
    Marks this ingest pipeline as deprecated.
When a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.
  - `_meta` (object)
    Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch.
  - `created_date` (union)
    Date and time when the pipeline was created. Only returned if the `human` query parameter is `true`.
  - `created_date_millis` (number)
    Date and time when the pipeline was created, in milliseconds since the epoch.
  - `modified_date` (union)
    Date and time when the pipeline was last modified. Only returned if the `human` query parameter is `true`.
  - `modified_date_millis` (number)
    Date and time when the pipeline was last modified, in milliseconds since the epoch.
  - `field_access_pattern` (enum · default: classic)
    Controls how processors in this pipeline should read and write data on a document's source.
    Values: `classic`, `flexible`
## Code examples

#### Console

```console
GET /_ingest/pipeline/my-pipeline-id
```

#### JavaScript

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

#### Python

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

#### curl

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

#### Java

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

#### C#

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

#### PHP

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

#### Ruby

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

## Response examples

#### Get pipeline response example1

A successful response for retrieving information about an ingest pipeline.

```json
{
  "my-pipeline-id" : {
    "description" : "describe pipeline",
    "version" : 123,
    "processors" : [
      {
        "set" : {
          "field" : "foo",
          "value" : "bar"
        }
      }
    ],
    "created_date" : "2024-01-01T12:00:00.000Z",
    "created_date_millis" : 1704110400000,
    "modified_date" : "2025-01-01T12:00:00.000Z",
    "modified_date_millis" : 1735732800000
  }
}
```