Get pipeline API

edit

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

PUT _ingest/pipeline/my-pipeline-id
{
  "description" : "describe pipeline",
  "version" : 123,
  "processors" : [
    {
      "set" : {
        "field": "foo",
        "value": "bar"
      }
    }
  ]
}

Examples

edit

Get information for a specific ingest pipeline

edit
GET _ingest/pipeline/my-pipeline-id

The API returns the following response:

{
  "my-pipeline-id" : {
    "description" : "describe pipeline",
    "version" : 123,
    "processors" : [
      {
        "set" : {
          "field" : "foo",
          "value" : "bar"
        }
      }
    ]
  }
}

Get the version of an ingest pipeline

edit

When you create or update an ingest pipeline, you can specify an optional version parameter. The version is useful for managing changes to pipeline and viewing the current pipeline for an ingest node.

PUT _ingest/pipeline/my-pipeline-id
{
  "description" : "describe pipeline",
  "version" : 123,
  "processors" : [
    {
      "set" : {
        "field": "foo",
        "value": "bar"
      }
    }
  ]
}

To check the pipeline version, use the filter_path query parameter to filter the response to only the version.

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

The API returns the following response:

{
  "my-pipeline-id" : {
    "version" : 123
  }
}