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

« GeoIP stats API Simulate 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.

response = client.ingest.get_pipeline(
  id: 'my-pipeline-id'
)
puts response

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 read_pipeline, 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 the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.

Examples

edit

Get information for a specific ingest pipeline

edit

response = client.ingest.get_pipeline(
  id: 'my-pipeline-id'
)
puts response

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

« GeoIP stats API Simulate pipeline API »