Create a saved query

Base URL: https://{kibana_url}

POST /api/osquery/saved_queries
POST /s/{space_id}/api/osquery/saved_queries

Auth

Create and save a query for later use.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Request body

description string: The saved query description.
ecs_mapping map string to object: Map osquery results columns or static values to Elastic Common Schema (ECS) fields
id string: The ID of a saved query.
interval string: An interval, in seconds, on which to run the query.
platform string: Restricts the query to a specified platform. The default is all platforms. To specify multiple platforms, use commas. For example, linux,darwin.
query string: The SQL query you want to run.
removed boolean: Indicates whether the query is removed.
snapshot boolean: Indicates whether the query is a snapshot.
version string: Uses the Osquery versions greater than or equal to the specified version string.

Response

Indicates a successful call.

application/json

data object required

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/osquery/saved_queries
{
  "description": "Saved query description",
  "ecs_mapping": {
    "host.uptime": {
      "field": "total_seconds"
    }
  },
  "id": "my_saved_query",
  "interval": "60",
  "platform": "linux,darwin",
  "query": "select * from uptime;",
  "timeout": 120
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/osquery/saved_queries" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Saved query description",
    "ecs_mapping": {
      "host.uptime": {
        "field": "total_seconds"
      }
    },
    "id": "my_saved_query",
    "interval": "60",
    "platform": "linux,darwin",
    "query": "select * from uptime;",
    "timeout": 120
  }'

Generated from the API spec

Response

{
  "data": {
    "created_at": "2025-02-26T13:37:30.452Z",
    "created_by": "elastic",
    "description": "Saved query description",
    "ecs_mapping": {
      "host.uptime": {
        "field": "total_seconds"
      }
    },
    "id": "my_saved_query",
    "interval": "60",
    "platform": "linux,darwin",
    "query": "select * from uptime;",
    "saved_object_id": "42ba1280-2172-11ee-8523-5765fca79a3c",
    "timeout": 120,
    "updated_at": "2025-02-26T13:37:30.452Z",
    "updated_by": "elastic"
  }
}