This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Put Search Application List Search Applications »

› › ›

Get Search Application

edit

Get Search Application

edit

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

edit

GET _application/search_application/<name>

Prerequisites

edit

Requires the manage_search_application cluster privilege.

Path parameters

edit

<name>: (Required, string)

Response codes

edit

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

Examples

edit

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

« Put Search Application List Search Applications »