IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Put pipeline API Delete pipeline API »

› › ›

Get pipeline API

edit

Get pipeline API

edit

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

GET /_ingest/pipeline/my-pipeline-id

Request

edit

GET /_ingest/pipeline/<pipeline>

GET /_ingest/pipeline

Prerequisites

edit

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

Path parameters

edit

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

edit

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.

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.

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

« Put pipeline API Delete pipeline API »