New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
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 query API Get live query results API »
Elastic Docs ›Kibana Guide [8.4] ›REST API ›Osquery manager API

Get live queries API

edit

Get 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

edit

GET <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.
perPage
(Optional, integer) The number of rules to return per page. The default is 20.
sortField

(Optional, string) The field that is used to sort the results. Options include createdAt or updatedAt. The default is createdAt.

Even though the JSON case object uses created_at and updated_at fields, you must use createdAt and updatedAt fields in the URL query.

sortOrder
(Optional, string) Specified the sort order. Options include desc or asc. The defaults is desc.

Response code

edit
200
Indicates a successful call.

Example

edit

Retrieve the last 10 live queries :

$ curl -X GET api/osquery/live_queries?page=1&perPage=10
Copy as curl 

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"],
        }
      ],
    },
    {...}
  ]
}
« Get live query API Get live query results API »

On this page

Was this helpful?
Feedback