New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
Elastic Docs ›Elasticsearch Guide ›REST APIs ›Search Application APIs
« Put Search Application List Search Applications »

Get Search Applicationedit

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.

Requestedit

GET _application/search_application/<name>

Prerequisitesedit

Requires the manage_search_application cluster privilege.

Path parametersedit

<name>
(Required, string)

Response codesedit

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

Examplesedit

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

GET _application/search_application/my-app/
Copy as curlView in Console 

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": "*"
      }
    }
  }
}

The indices associated with a search application are not returned with the GET response. To view the indices, use the get alias API. The alias name will match the search application name, for example my-app in the example above.

« Put Search Application List Search Applications »