You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Get pipeline APIedit
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
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
read_pipeline,manage_pipeline,manage_ingest_pipelines, ormanagecluster 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
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"
}
}
]
}
}