› › ›

Get Search Application

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Retrieves information about a search application.

Request

GET _application/search_application/<name>

Prerequisites

Requires the manage_search_application cluster privilege.

Path parameters

<name>: (Required, string)

Response codes

400: The name was not provided.
404 (Missing resources): No Search Application matching name could be found.

Examples

The following example gets the Search Application named my-app:

resp = client.search_application.get(
    name="my-app",
)
print(resp)

const response = await client.searchApplication.get({
  name: "my-app",
});
console.log(response);

GET _application/search_application/my-app/

A sample response:

{
  "name": "my-app",
  "indices": [ "index1", "index2" ],
  "updated_at_millis": 1682105622204,
  "template": {
    "script": {
      "source": {
        "query": {
          "query_string": {
            "query": "{{query_string}}",
            "default_field": "{{default_field}}"
          }
        }
      },
      "lang": "mustache",
      "options": {
        "content_type": "application/json;charset=utf-8"
      },
      "params": {
        "query_string": "*",
        "default_field": "*"
      }
    }
  }
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-search-application.html