Run a search with a search template

POST also GET /{index}/_search/template
POST also GET /_search/template

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Query parameters

allow_no_indices boolean · default: true

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

ccs_minimize_roundtrips boolean · default: false

If true, network round-trips are minimized for cross-cluster search requests.

expand_wildcards string · default: open

The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

Supported values include:

all: Match any data stream or index, including hidden ones.
open: Match open, non-hidden indices. Also matches any non-hidden data stream.
closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
none: Wildcard expressions are not accepted.

Values: all open closed hidden none

explain boolean · default: false

If true, the response includes additional details about score computation as part of a hit.

ignore_throttled boolean · default: true deprecated

If true, specified concrete, expanded, or aliased indices are not included in the response when throttled.

ignore_unavailable boolean · default: false

If false, the request returns an error if it targets a missing or closed index.

preference string

The node or shard the operation should be performed on. It is random by default.

profile boolean · default: false

If true, the query execution is profiled.

routing string

A custom value used to route operations to a specific shard.

scroll string

Specifies how long a consistent view of the index should be maintained for scrolled search.

Reference

search_type enum

The type of the search operation.

Supported values include:

query_then_fetch: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.
dfs_query_then_fetch: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.

Values: query_then_fetch dfs_query_then_fetch

rest_total_hits_as_int boolean · default: false

If true, hits.total is rendered as an integer in the response. If false, it is rendered as an object.

typed_keys boolean · default: false

If true, the response prefixes aggregation and suggester names with their respective types.

Request body

Response

application/json

Examples

Request Console 1 / 8 languages

Run POST my-index/_search/template to run a search with a search template.

Console Kibana Dev Tools

POST my-index/_search/template
{
  "id": "my-search-template",
  "params": {
    "query_string": "hello world",
    "from": 0,
    "size": 10
  }
}

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

client.searchTemplate(s -> s
    .id("my-search-template")
    .index("my-index")
    .params(Map.of("size", JsonData.fromJson("10"),"from", JsonData.fromJson("0"),"query_string", JsonData.fromJson("\"hello world\"")))
);

C# Elasticsearch .NET Client

var response = await client
    .SearchTemplateAsync<MyDocument>(d1 => d1
        .Indices(new[] { "my-index" })
        .Id("my-search-template")
        .Params(new Dictionary<string, object>()
        {
            { "query_string", "hello world" },
            { "from", 0 },
            { "size", 10 }
        })
    );

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

No example

Run a search with a search template

Required authorization

Authentication

Path parameters

Query parameters

Request body

Response

Required authorization

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body