2022-02-04 10:37:42 -05:00
|
|
|
---
|
|
|
|
layout: default
|
|
|
|
title: Get ingest pipeline
|
|
|
|
parent: Ingest APIs
|
|
|
|
nav_order: 10
|
2023-05-04 13:44:02 -04:00
|
|
|
redirect_from:
|
|
|
|
- /opensearch/rest-api/ingest-apis/get-ingest/
|
2022-02-04 10:37:42 -05:00
|
|
|
---
|
|
|
|
|
|
|
|
## Get ingest pipeline
|
|
|
|
|
|
|
|
After you create a pipeline, use the get ingest pipeline API operation to return all the information about a specific ingest pipeline.
|
|
|
|
|
|
|
|
## Example
|
|
|
|
|
|
|
|
```
|
2022-02-07 13:49:43 -05:00
|
|
|
GET _ingest/pipeline/12345
|
2022-02-04 10:37:42 -05:00
|
|
|
```
|
2023-01-30 17:09:38 -05:00
|
|
|
{% include copy-curl.html %}
|
2022-02-04 10:37:42 -05:00
|
|
|
|
|
|
|
## Path and HTTP methods
|
|
|
|
|
|
|
|
Return all ingest pipelines.
|
|
|
|
|
|
|
|
```
|
|
|
|
GET _ingest/pipeline
|
|
|
|
```
|
|
|
|
|
|
|
|
Returns a single ingest pipeline based on the pipeline's ID.
|
|
|
|
|
|
|
|
```
|
|
|
|
GET _ingest/pipeline/{id}
|
|
|
|
```
|
|
|
|
|
|
|
|
## URL parameters
|
|
|
|
|
|
|
|
All parameters are optional.
|
|
|
|
|
|
|
|
Parameter | Type | Description
|
|
|
|
:--- | :--- | :---
|
2022-02-04 12:44:49 -05:00
|
|
|
master_timeout | time | How long to wait for a connection to the master node.
|
2022-02-04 10:37:42 -05:00
|
|
|
|
|
|
|
## Response
|
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"pipeline-id" : {
|
|
|
|
"description" : "A description for your pipeline",
|
|
|
|
"processors" : [
|
|
|
|
{
|
|
|
|
"set" : {
|
|
|
|
"field" : "field-name",
|
|
|
|
"value" : "value"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|