Get search applications Beta; Added in 8.8.0

View as markdown

GET /_application/search_application

Api key auth Basic auth Bearer auth

Get information about search applications.

Required authorization

Cluster privileges: manage_search_application

Query parameters

q string

Query in the Lucene query string syntax.
from number

Starting offset.
size number

Specifies a max number of results to get.

Responses

200 application/json
Hide response attributes Show response attributes object
- count number Required
- results array[object] Required
  
  Hide results attributes Show results attributes object
  
  indices array[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
  
  Time unit for milliseconds

GET /_application/search_application

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

resp = client.search_application.list(
    from="0",
    size="3",
    q="app*",
)

const response = await client.searchApplication.list({
  from: 0,
  size: 3,
  q: "app*",
});

response = client.search_application.list(
  from: "0",
  size: "3",
  q: "app*"
)

$resp = $client->searchApplication()->list([
    "from" => "0",
    "size" => "3",
    "q" => "app*",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_application/search_application?from=0&size=3&q=app*"

client.searchApplication().list(l -> l
    .from(0)
    .q("app*")
    .size(3)
);

Response examples (200)

A succesful response from `GET _application/search_application?from=0&size=3&q=app*` returns the first three search applications whose names start with `app`.

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