Render search template API
editRender search template API
editRenders a search template as a search request body.
resp = client.render_search_template( id="my-search-template", params={ "query_string": "hello world", "from": 20, "size": 10 }, ) print(resp)
response = client.render_search_template( body: { id: 'my-search-template', params: { query_string: 'hello world', from: 20, size: 10 } } ) puts response
const response = await client.renderSearchTemplate({ id: "my-search-template", params: { query_string: "hello world", from: 20, size: 10, }, }); console.log(response);
POST _render/template { "id": "my-search-template", "params": { "query_string": "hello world", "from": 20, "size": 10 } }
Request
editGET _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 theid
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.