IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Get Search Application Delete Search Application »

› › ›

List Search Applications

edit

List Search Applications

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.

Returns information about Search Applications.

Request

edit

GET _application/search_application/

Prerequisites

edit

Requires the manage_search_application cluster privilege.

Path parameters

edit

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 codes

edit

Examples

edit

The following example lists all configured search applications:

GET _application/search_application/

The following example lists the first three search applications whose names match the query string app:

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

A sample response:

{
  "count": 2,
  "results": [
    {
      "name": "app-1",
      "indices": [ "index1", "index2" ]
    },
    {
      "name": "app-2",
      "indices": [ "index3", "index4" ]
    }
  ],
  "updated_at_millis": 1682105622204
}

« Get Search Application Delete Search Application »