Render a search template

POST also GET /_render/template/{id}
POST also GET /_render/template

Auth

Render a search template as a search request body.

Required authorization

Index privileges read

Path parameters

id string optional

The ID of the search template to render. If no source is specified, this or the id request body parameter is required.

Leave it out to use /_render/template.

Request body

id string: The 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>.
file string
params map string to 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 string: An inline search template. It 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.

Response

application/json

template_output map string to object required

Examples

Request Console 1 / 8 languages

Run POST _render/template

Console Kibana Dev Tools

POST _render/template
{
  "id": "my-search-template",
  "params": {
    "query_string": "hello world",
    "from": 20,
    "size": 10
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.renderSearchTemplate({
  id: "my-search-template",
  params: {
    query_string: "hello world",
    from: 20,
    size: 10,
  },
});

Python Elasticsearch Python Client

resp = client.render_search_template(
    id="my-search-template",
    params={
        "query_string": "hello world",
        "from": 20,
        "size": 10
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_render/template" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "my-search-template",
    "params": {
      "query_string": "hello world",
      "from": 20,
      "size": 10
    }
  }'

Java Elasticsearch Java Client

client.renderSearchTemplate(r -> r
    .id("my-search-template")
    .params(Map.of("size", JsonData.fromJson("10"),"from", JsonData.fromJson("20"),"query_string", JsonData.fromJson("\"hello world\"")))
);

C# Elasticsearch .NET Client

var response = await client
    .RenderSearchTemplateAsync(d1 => d1
        .Id("my-search-template")
        .Params(new Dictionary<string, object>()
        {
            { "query_string", "hello world" },
            { "from", 20 },
            { "size", 10 }
        })
    );

PHP Elasticsearch PHP Client

$resp = $client->renderSearchTemplate([
    "body" => [
        "id" => "my-search-template",
        "params" => [
            "query_string" => "hello world",
            "from" => 20,
            "size" => 10,
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

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

Response

{
  "template_output": {
    "key": {}
  }
}

Generated from the API spec