This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Get pipeline

Use the get ingest pipeline API operation to retrieve all the information about the pipeline.

Retrieving information about all pipelines

The following example request returns information about all ingest pipelines:

  1. GET _ingest/pipeline/

copy

Retrieving information about a specific pipeline

The following example request returns information about a specific pipeline, which for this example is my-pipeline:

  1. GET _ingest/pipeline/my-pipeline

copy

The response contains the pipeline information:

  1. {
  2.   "my-pipeline": {
  3.     "description": "This pipeline processes student data",
  4.     "processors": [
  5.       {
  6.         "set": {
  7.           "description": "Sets the graduation year to 2023",
  8.           "field": "grad_year",
  9.           "value": 2023
  10.         }
  11.       },
  12.       {
  13.         "set": {
  14.           "description": "Sets graduated to true",
  15.           "field": "graduated",
  16.           "value": true
  17.         }
  18.       },
  19.       {
  20.         "uppercase": {
  21.           "field": "name"
  22.         }
  23.       }
  24.     ]
  25.   }
  26. }