lqb
/
elasticsearch
mirror of https://gitee.com/mirrors/elasticsearch.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
							[role="xpack"]
[[put-search-application]]
=== Put Search Application

preview::[]

++++
<titleabbrev>Put Search Application</titleabbrev>
++++

Creates or updates a Search Application.

[[put-search-application-request]]
==== {api-request-title}

`PUT _application/search_application/<name>`

[[put-search-application-prereqs]]
==== {api-prereq-title}

Requires the `manage_search_application` cluster privilege.
Also requires <<privileges-list-indices,manage privileges>> on all indices that are added to the Search Application.

[[put-search-application-path-params]]
==== {api-path-parms-title}


`create`::
(Optional, Boolean) If `true`, this request cannot replace or update existing Search Applications.
Defaults to `false`.

`<body>`::
(Required, object)
Contains parameters for a search application:
+
.Properties of `<body>` objects
[%collapsible%open]
====
`indices`::
(Required, array of strings)
The <<indices,indices>> associated with this search application. All indices need to exist in order to be added to a search application.

`template`::
(Optional, object)
The <<search-template,search template>> associated with this search application. The search application's template is only stored and accessible through the search application.

- This search template must be a Mustache template.
- The template must contain a Mustache script and script source.
- The template may be modified with subsequent <<put-search-application,put search application>> requests.
- If no template is specified when creating a search application, or if a template is removed from a search application, we use the <<query-string-query-ex-request,query_string>> defined in the template examples as a default.
- This template will be used by the <<search-application-search,search application search>> API to execute searches.
====


[[put-search-application-response-codes]]
==== {api-response-codes-title}

`404`::
Search Application `<name>` does not exist.

`409`::
Search Application `<name>` exists and `create` is `true`.

[[put-search-application-example]]
==== {api-examples-title}

The following example creates a new Search Application called `my-app`:

[source,console]
----
PUT _application/search_application/my-app?create
{
  "indices": [ "index1", "index2" ],
  "template": {
    "script": {
      "source": {
        "query": {
          "query_string": {
            "query": "{{query_string}}",
            "default_field": "{{default_field}}"
          }
        }
      },
      "params": {
        "query_string": "*",
        "default_field": "*"
      }
    }
  }
}
----
// TEST[skip:TBD]

The following example creates or updates an existing Search Application called `my-app`:

[source,console]
----
PUT _application/search_application/my-app
{
  "indices": [ "index1", "index2", "index3" ],
  "template": {
    "script": {
      "source": {
        "query": {
          "query_string": {
            "query": "{{query_string}}",
            "default_field": "{{default_field}}"
          }
        }
      },
      "params": {
        "query_string": "*",
        "default_field": "*"
      }
    }
  }
}
----
// TEST[skip:TBD]