Get search applications

GET /_application/search_application

Auth

Get information about search applications.

Required privileges

Cluster privileges manage_search_application

Query parameters

q string: Query in the Lucene query string syntax.
from number · default: 0: Starting offset.
size number: Specifies a max number of results to get.

Response

application/json

count number required
results object[] required

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

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

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

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

C# Elasticsearch .NET Client

var response = await client.SearchApplication
    .ListAsync(d1 => d1
        .From(0)
        .QueryLuceneSyntax("app*")
        .Size(3)
    );

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

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
    }
  ]
}