This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Get pipeline API
editGet pipeline API
editReturns information about one or more ingest pipelines. This API returns a local reference of the pipeline.
resp = client.ingest.get_pipeline(
id="my-pipeline-id",
)
print(resp)
response = client.ingest.get_pipeline( id: 'my-pipeline-id' ) puts response
const response = await client.ingest.getPipeline({
id: "my-pipeline-id",
});
console.log(response);
GET /_ingest/pipeline/my-pipeline-id
Prerequisites
edit-
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 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-1to indicate that the request should never timeout.
Examples
editGet information for a specific ingest pipeline
editresp = client.ingest.get_pipeline(
id="my-pipeline-id",
)
print(resp)
response = client.ingest.get_pipeline( id: 'my-pipeline-id' ) puts response
const response = await client.ingest.getPipeline({
id: "my-pipeline-id",
});
console.log(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"
}
}
]
}
}