mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 18:27:59 -04:00
f0f1775632
## Summary Contributes to https://github.com/elastic/security-docs-internal/issues/48. Add callouts to the asciidoc Osquery API docs to direct users to the new API reference site, in preparation for retiring the asciidoc API docs. NOTE: The api-kibana variable is defined in version-specific files. In [8.15.asciidoc](873ec2c47f/shared/versions/stack/8.15.asciidoc (L74)) and [8.x.asciidoc](873ec2c47f/shared/versions/stack/8.x.asciidoc (L75)), the variable points to the [v8 branch](https://www.elastic.co/docs/api/doc/kibana/v8) of the API reference, which currently doesn't include Security API docs. The v8 branch is derived from the "current" Kibana branch, which is currently 8.15. This likely means that we can only backport the callouts to 8.16 once 8.16 becomes the "current" docs version. Preview: [Osquery manager API](https://kibana_bk_195909.docs-preview.app.elstc.co/guide/en/kibana/master/osquery-manager-api.html) and all its child pages
70 lines
1.8 KiB
Text
70 lines
1.8 KiB
Text
[[osquery-manager-live-queries-api-get-results]]
|
|
=== Get live query results API
|
|
++++
|
|
<titleabbrev>Get live query results</titleabbrev>
|
|
++++
|
|
|
|
.New API Reference
|
|
[sidebar]
|
|
--
|
|
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
|
|
--
|
|
|
|
experimental[] Retrieve a single live query result by ID.
|
|
|
|
|
|
[[osquery-manager-live-queries-api-get-results-request]]
|
|
==== Request
|
|
|
|
`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>`
|
|
|
|
|
|
[[osquery-manager-live-queries-api-get-results-params]]
|
|
==== Path parameters
|
|
|
|
`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.
|
|
|
|
|
|
|
|
[[osquery-manager-live-queries-api-get-results-codes]]
|
|
==== Response code
|
|
|
|
`200`::
|
|
Indicates a successful call.
|
|
|
|
`404`::
|
|
The specified live query or <query_action_id> doesn't exist.
|
|
|
|
|
|
[[osquery-manager-live-queries-api-get-results-example]]
|
|
==== Example
|
|
|
|
Retrieve the live query results for `3c42c847-eb30-4452-80e0-728584042334` ID and `609c4c66-ba3d-43fa-afdd-53e244577aa0` query action ID:
|
|
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
$ curl -X GET api/osquery/live_queries/3c42c847-eb30-4452-80e0-728584042334/results/609c4c66-ba3d-43fa-afdd-53e244577aa0
|
|
--------------------------------------------------
|
|
// KIBANA
|
|
|
|
The API returns a live query action single query result:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
{
|
|
"data": {
|
|
"total": 2,
|
|
"edges": [{...}, {...}],
|
|
}
|
|
}
|
|
--------------------------------------------------
|