Get Pipeline API

Introduced 1.0

The Get Pipeline API returns the definitions of one or more ingest pipelines.

Endpoints

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

Path parameters

The following table lists the available path parameters. All path parameters are optional.

Query parameters

The following table lists the available query parameters. All query parameters are optional.

Example request

The following request returns the definition of the my-pipeline pipeline:

GET /_ingest/pipeline/my-pipeline

The following request returns the definitions of all pipelines whose IDs start with logs- and of the orders-pipeline pipeline:

GET /_ingest/pipeline/logs-*,orders-pipeline

To retrieve only the version of a pipeline, filter the response using the filter_path query parameter. For more information, see Pipeline versioning.

GET /_ingest/pipeline/my-pipeline?filter_path=*.version

Example response

The response contains the definition of each requested pipeline, keyed by pipeline ID:

{
  "my-pipeline": {
    "description": "This pipeline processes student data",
    "processors": [
      {
        "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"
        }
      }
    ]
  }
}

If no pipeline matches the specified ID, the API returns an empty object and a 404 status code.

Response body fields

The response contains one object for each returned pipeline, named after the pipeline ID. Each pipeline object contains the following fields.

Required permissions

If you use the Security plugin, make sure you have the appropriate permissions: cluster:admin/ingest/pipeline/get.