List Search Applicationsedit

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.

Returns information about Search Applications.

Requestedit

GET _application/search_application/

Prerequisitesedit

Requires the manage_search_application cluster privilege.

Path parametersedit

q
(Optional, string) Query in the Lucene query string syntax, to return only search applications matching the query.
size
(Optional, integer) Maximum number of results to retrieve.
from
(Optional, integer) The offset from the first result to fetch.

Response codesedit

Examplesedit

The following example lists all configured search applications:

GET _application/search_application/

The following example queries the first three search applications whose names start with app:

GET _application/search_application?from=0&size=3&q=app*

A sample response:

{
  "count": 2,
  "results": [
    {
      "name": "app-1",
      "updated_at_millis": 1690981129366
    },
    {
      "name": "app-2",
      "updated_at_millis": 1691501823939
    }
  ]
}