IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Multi search template API Search shards API »
Elastic Docs ›Elasticsearch Guide [8.9] ›REST APIs ›Search APIs

Render search template API

edit

Render search template API

edit

Renders a search template as a search request body.

response = client.render_search_template(
  body: {
    id: 'my-search-template',
    params: {
      query_string: 'hello world',
      from: 20,
      size: 10
    }
  }
)
puts response
POST _render/template
{
  "id": "my-search-template",
  "params": {
    "query_string": "hello world",
    "from": 20,
    "size": 10
  }
}

Request

edit

GET _render/template

GET _render/template/<template-id>

POST _render/template

POST _render/template/<template-id>

Prerequisites

edit
  • If the Elasticsearch security features are enabled, you must have the read index privilege for at least one index pattern.

Path parameters

edit
<template-id>
(Required*, string) ID of the search template to render. If no source is specified, this or the id request body parameter is required.

Request body

edit
id
(Required*, string) ID of the search template to render. If no source is specified, this or the <template-id> request path parameter is required. If you specify both this parameter and the <template-id> parameter, the API uses only <template-id>.
params
(Optional, object) Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value.
source
(Required*, object) An inline search template. Supports the same parameters as the search API's request body. These parameters also support Mustache variables. If no id or <templated-id> is specified, this parameter is required.
« Multi search template API Search shards API »