2022-02-04 10:37:42 -05:00
|
|
|
---
|
|
|
|
layout: default
|
2023-08-29 16:07:34 -04:00
|
|
|
title: Get pipeline
|
|
|
|
nav_order: 12
|
2023-05-04 13:44:02 -04:00
|
|
|
redirect_from:
|
|
|
|
- /opensearch/rest-api/ingest-apis/get-ingest/
|
2023-10-17 17:22:28 -04:00
|
|
|
- /api-reference/ingest-apis/get-ingest/
|
2022-02-04 10:37:42 -05:00
|
|
|
---
|
|
|
|
|
2023-08-29 16:07:34 -04:00
|
|
|
# Get pipeline
|
2023-10-23 10:53:52 -04:00
|
|
|
**Introduced 1.0**
|
|
|
|
{: .label .label-purple }
|
2022-02-04 10:37:42 -05:00
|
|
|
|
2023-08-29 16:07:34 -04:00
|
|
|
Use the get ingest pipeline API operation to retrieve all the information about the pipeline.
|
2022-02-04 10:37:42 -05:00
|
|
|
|
2023-08-29 16:07:34 -04:00
|
|
|
## Retrieving information about all pipelines
|
2022-02-04 10:37:42 -05:00
|
|
|
|
2023-08-29 16:07:34 -04:00
|
|
|
The following example request returns information about all ingest pipelines:
|
|
|
|
|
|
|
|
```json
|
|
|
|
GET _ingest/pipeline/
|
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
|
|
|
|
2023-08-29 16:07:34 -04:00
|
|
|
## Retrieving information about a specific pipeline
|
2022-02-04 10:37:42 -05:00
|
|
|
|
2023-08-29 16:07:34 -04:00
|
|
|
The following example request returns information about a specific pipeline, which for this example is `my-pipeline`:
|
2022-02-04 10:37:42 -05:00
|
|
|
|
2023-08-29 16:07:34 -04:00
|
|
|
```json
|
|
|
|
GET _ingest/pipeline/my-pipeline
|
2022-02-04 10:37:42 -05:00
|
|
|
```
|
2023-08-29 16:07:34 -04:00
|
|
|
{% include copy-curl.html %}
|
2022-02-04 10:37:42 -05:00
|
|
|
|
2023-08-29 16:07:34 -04:00
|
|
|
The response contains the pipeline information:
|
2022-02-04 10:37:42 -05:00
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
2023-08-29 16:07:34 -04:00
|
|
|
"my-pipeline": {
|
|
|
|
"description": "This pipeline processes student data",
|
|
|
|
"processors": [
|
2022-02-04 10:37:42 -05:00
|
|
|
{
|
2023-08-29 16:07:34 -04:00
|
|
|
"set": {
|
|
|
|
"description": "Sets the graduation year to 2023",
|
|
|
|
"field": "grad_year",
|
|
|
|
"value": 2023
|
|
|
|
}
|
|
|
|
},
|
|
|
|
{
|
|
|
|
"set": {
|
|
|
|
"description": "Sets graduated to true",
|
|
|
|
"field": "graduated",
|
|
|
|
"value": true
|
|
|
|
}
|
|
|
|
},
|
|
|
|
{
|
|
|
|
"uppercase": {
|
|
|
|
"field": "name"
|
2022-02-04 10:37:42 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
}
|
2023-08-29 16:07:34 -04:00
|
|
|
```
|