Get pipeline APIedit

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

GET /_ingest/pipeline/my-pipeline-id

Requestedit

GET /_ingest/pipeline/<pipeline>

GET /_ingest/pipeline

Prerequisitesedit

  • If the Elasticsearch security features are enabled, you must have the read_pipeline, manage_pipeline, manage_ingest_pipelines, or manage cluster privilege to use this API.

Path parametersedit

<pipeline>

(Optional, string) Comma-separated list of pipeline IDs to retrieve. Wildcard (*) expressions are supported.

To get all ingest pipelines, omit this parameter or use *.

Query parametersedit

master_timeout
(Optional, time units) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

Examplesedit

Get information for a specific ingest pipelineedit

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 pipelineedit

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.

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
  }
}