This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
List Search Applications
editList Search Applications
editThis 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
editGET _application/search_application/
Prerequisites
editRequires 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
editExamples
editThe following example lists all configured search applications:
resp = client.search_application.list() print(resp)
const response = await client.searchApplication.list(); console.log(response);
GET _application/search_application/
The following example queries the first three search applications whose names start with app:
resp = client.search_application.list(
from_="0",
size="3",
q="app*",
)
print(resp)
const response = await client.searchApplication.list({
from: 0,
size: 3,
q: "app*",
});
console.log(response);
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
}
]
}