Get search application details

GET /_application/search_application/{name}

Auth

Required privileges

Cluster privileges manage_search_application

Path parameters

name string required: The name of the search application

Response

application/json

indices string[] required: Indices that are part of the Search Application.
analytics_collection_name string: Analytics collection associated to the Search Application.
template object: Search template to use on search operations.
name string required: Search Application name
updated_at_millis number required: Last time the Search Application was updated.

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _application/search_application/my-app/

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_application/search_application/my-app/" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.searchApplication().get(g -> g
    .name("my-app")
);

C# Elasticsearch .NET Client

var response = await client.SearchApplication.GetAsync(name: "my-app");

PHP Elasticsearch PHP Client

$resp = $client->searchApplication()->get([
    "name" => "my-app",
]);

Ruby Elasticsearch Ruby Client

response = client.search_application.get(
  name: "my-app"
)

Response

A sucessful response from GET _application/search_application/my-app/.

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