IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get live queries API
editGet live queries API
edit[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Get live queries.
Request
editGET <kibana host>:<port>/api/osquery/live_queries
GET <kibana host>:<port>/s/<space_id>/api/osquery/live_queries
Path parameters
edit-
space_id
-
(Optional, string) An identifier for the space. When
space_id
is not provided in the URL, the default space is used.
Query parameters
edit-
page
-
(Optional, integer) The page number to return. The default is
1
. -
pageSize
-
(Optional, integer) The number of rules to return per page. The default is
20
. -
sort
-
(Optional, string) The field that is used to sort the results. Options include
createdAt
orupdatedAt
. The default iscreatedAt
.Even though the JSON case object uses
created_at
andupdated_at
fields, you must usecreatedAt
andupdatedAt
fields in the URL query. -
sortOrder
-
(Optional, string) Specified the sort order. Options include
desc
orasc
. The default isdesc
.
Response code
edit-
200
- Indicates a successful call.
Example
editRetrieve the last 10 live queries :
$ curl -X GET api/osquery/live_queries?page=1&perPage=10
The API returns a JSON object of the retrieved live queries:
{ "page": 1, "per_page": 10, "total": 11, "data": [ { "action_id": "3c42c847-eb30-4452-80e0-728584042334", "expiration": "2022-07-26T10:04:32.220Z", "@timestamp": "2022-07-26T09:59:32.220Z", "agents": ["16d7caf5-efd2-4212-9b62-73dafc91fa13"], "user_id": "elastic", "queries": [ { "action_id": "609c4c66-ba3d-43fa-afdd-53e244577aa0", "id": "6724a474-cbba-41ef-a1aa-66aebf0879e2", "query": "select * from uptime;", "saved_query_id": "42ba9c50-0cc5-11ed-aa1d-2b27890bc90d", "ecs_mapping": { "host.uptime": { "field": "total_seconds" } }, "agents": ["16d7caf5-efd2-4212-9b62-73dafc91fa13"], } ], }, {...} ] }