You're viewing version 2.17 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.

Render Template

The Render Template API renders a search template as a search query.

Paths and HTTP methods

GET /_render/template
POST /_render/template
GET /_render/template/<id>
POST /_render/template/<id>

Path parameters

The Render Template API supports the following optional path parameter.

Request body fields

The following options are supported in the request body of the Render Template API.

Example request

Both of the following request examples use the search template with the template ID play_search_template:

{
  "source": {
    "query": {
      "match": {
        "play_name": "{{play_name}}"
      }
    }
  },
  "params": {
    "play_name": "Henry IV"
  }
}

Render template using template ID

The following example request validates a search template with the ID play_search_template:

POST _render/template
{
  "id": "play_search_template",
  "params": {
    "play_name": "Henry IV"
  }
}

Render template using _source

If you don’t want to use a saved template, or want to test a template before saving, you can test a template with the _source parameter using Mustache variables, as shown in the following example:

{
  "source": {
     "from": "{{from}}{{^from}}0{{/from}}",
     "size": "{{size}}{{^size}}10{{/size}}",
    "query": {
      "match": {
        "play_name": "{{play_name}}"
      }
    }
  },
  "params": {
    "play_name": "Henry IV"
  }
}

Example response

OpenSearch responds with information about the template’s output:

{
  "template_output": {
    "from": "0",
    "size": "10",
    "query": {
      "match": {
        "play_name": "Henry IV"
      }
    }
  }
}