IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Get saved query API Create saved query API »
Elastic Docs ›Kibana Guide [8.5] ›REST API ›Osquery manager API

Get saved-queries API

edit

Get saved-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 saved queries.

Request

edit

GET <kibana host>:<port>/api/osquery/saved_queries

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

Path parameters

edit
space_id
(Optional, string) The space identifier. 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) Specifies the field that sorts the results. Options include createdAt or updatedAt. The default is createdAt.

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

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

Response code

edit
200
Indicates a successful call.

Example

edit

Retrieve the first 10 saved queries:

$ curl -X GET api/osquery/saved-queries?page=1&perPage=10&sortField=updatedAt&sortOrder=asc

The API returns a JSON object of the retrieved saved queries:

{
  "page": 1,
  "per_page": 100,
  "total": 11,
  "data": [
    {
      "type": "osquery-saved-query",
      "id": "42ba9c50-0cc5-11ed-aa1d-2b27890bc90d",
      "namespaces": ["default"],
      "attributes": {
        "id": "saved_query_id",
        "description": "Saved query description",
        "query": "select * from uptime;",
        "platform": "linux,darwin",
        "version": "2.8.0",
        "interval": "60",
        "ecs_mapping": {
          "host.uptime": {
            "field": "total_seconds"
          }
        },
        "created_by": "elastic",
        "created_at": "2022-07-26T09:28:08.597Z",
        "updated_by": "elastic",
        "updated_at": "2022-07-26T09:28:08.597Z",
        "prebuilt": false
      },
    },
    {...}
  ]
}
« Get saved query API Create saved query API »