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.
« Get live queries API Create live query API »
Elastic Docs ›Kibana Guide [master] ›REST API ›Osquery manager API

Get live query results API

edit

Get live query results API

edit

New API Reference

For the most up-to-date API details, refer to Osquery APIs.

[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. Retrieve a single live query result by ID.

Request

edit

GET <kibana host>:<port>/api/osquery/live_queries/<id>/results/<query_action_id>

GET <kibana host>:<port>/s/<space_id>/api/osquery/live_queries/<query_action_id>

Path parameters

edit
space_id
(Optional, string) The space identifier. When space_id is not provided in the URL, the default space is used.
id
(Required, string) The ID of the live query result you want to retrieve.
query_action_id
(Required, string) The ID of the query action that generated the live query results.

Response code

edit
200
Indicates a successful call.
404
The specified live query or <query_action_id> doesn’t exist.

Example

edit

Retrieve the live query results for 3c42c847-eb30-4452-80e0-728584042334 ID and 609c4c66-ba3d-43fa-afdd-53e244577aa0 query action ID:

$ curl -X GET api/osquery/live_queries/3c42c847-eb30-4452-80e0-728584042334/results/609c4c66-ba3d-43fa-afdd-53e244577aa0

The API returns a live query action single query result:

{
  "data": {
    "total": 2,
    "edges": [{...}, {...}],
  }
}
« Get live queries API Create live query API »