Render search template API

Render search template API

Renders a search template as a search request body.

  1. POST _render/template
  2. {
  3.   "id": "my-search-template",
  4.   "params": {
  5.     "query_string": "hello world",
  6.     "from": 20,
  7.     "size": 10
  8.   }
  9. }

Request

GET _render/template

GET _render/template/<template-id>

POST _render/template

POST _render/template/<template-id>

Prerequisites

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

Path parameters

<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

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.