Link Search Menu Expand Document Documentation Menu

You're viewing version 2.16 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Retrieving search pipelines

To retrieve the details of an existing search pipeline, use the Search Pipeline API.

To view all search pipelines, use the following request:

GET /_search/pipeline

The response contains the pipeline that you set up in the previous section:

Response
{
  "my_pipeline" : {
    "request_processors" : [
      {
        "filter_query" : {
          "tag" : "tag1",
          "description" : "This processor is going to restrict to publicly visible documents",
          "query" : {
            "term" : {
              "visibility" : "public"
            }
          }
        }
      }
    ]
  }
}

To view a particular pipeline, specify the pipeline name as a path parameter:

GET /_search/pipeline/my_pipeline

You can also use wildcard patterns to view a subset of pipelines, for example:

GET /_search/pipeline/my*

350 characters left

Have a question? .

Want to contribute? or .