mirror of
https://github.com/elastic/kibana.git
synced 2025-06-30 03:53:20 -04:00
d0f095f2ec
# Backport This will backport the following commits from `main` to `8.x`: - [[DOCS ]Direct users to new API reference site (#195909)](https://github.com/elastic/kibana/pull/195909) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"natasha-moore-elastic","email":"137783811+natasha-moore-elastic@users.noreply.github.com"},"sourceCommit":{"committedDate":"2024-10-15T15:29:05Z","message":"[DOCS ]Direct users to new API reference site (#195909)\n\n## Summary\r\n\r\nContributes to\r\nhttps://github.com/elastic/security-docs-internal/issues/48.\r\n\r\nAdd callouts to the asciidoc Osquery API docs to direct users to the new\r\nAPI reference site, in preparation for retiring the asciidoc API docs.\r\n\r\nNOTE: The api-kibana variable is defined in version-specific files. In\r\n[8.15.asciidoc](873ec2c47f/shared/versions/stack/8.x.asciidoc (L75)),\r\nthe variable points to the [v8\r\nbranch](https://www.elastic.co/docs/api/doc/kibana/v8) of the API\r\nreference, which currently doesn't include Security API docs. The v8\r\nbranch is derived from the \"current\" Kibana branch, which is currently\r\n8.15. This likely means that we can only backport the callouts to 8.16\r\nonce 8.16 becomes the \"current\" docs version.\r\n\r\nPreview: [Osquery manager\r\nAPI](https://kibana_bk_195909.docs-preview.app.elstc.co/guide/en/kibana/master/osquery-manager-api.html)\r\nand all its child pages","sha":"f0f17756324836e00ae0440ed1ba34c90490e843","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","Feature:Osquery","APIDocs","v8.16.0","backport:version"],"title":"[DOCS ]Direct users to new API reference site","number":195909,"url":"https://github.com/elastic/kibana/pull/195909","mergeCommit":{"message":"[DOCS ]Direct users to new API reference site (#195909)\n\n## Summary\r\n\r\nContributes to\r\nhttps://github.com/elastic/security-docs-internal/issues/48.\r\n\r\nAdd callouts to the asciidoc Osquery API docs to direct users to the new\r\nAPI reference site, in preparation for retiring the asciidoc API docs.\r\n\r\nNOTE: The api-kibana variable is defined in version-specific files. In\r\n[8.15.asciidoc](873ec2c47f/shared/versions/stack/8.x.asciidoc (L75)),\r\nthe variable points to the [v8\r\nbranch](https://www.elastic.co/docs/api/doc/kibana/v8) of the API\r\nreference, which currently doesn't include Security API docs. The v8\r\nbranch is derived from the \"current\" Kibana branch, which is currently\r\n8.15. This likely means that we can only backport the callouts to 8.16\r\nonce 8.16 becomes the \"current\" docs version.\r\n\r\nPreview: [Osquery manager\r\nAPI](https://kibana_bk_195909.docs-preview.app.elstc.co/guide/en/kibana/master/osquery-manager-api.html)\r\nand all its child pages","sha":"f0f17756324836e00ae0440ed1ba34c90490e843"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/195909","number":195909,"mergeCommit":{"message":"[DOCS ]Direct users to new API reference site (#195909)\n\n## Summary\r\n\r\nContributes to\r\nhttps://github.com/elastic/security-docs-internal/issues/48.\r\n\r\nAdd callouts to the asciidoc Osquery API docs to direct users to the new\r\nAPI reference site, in preparation for retiring the asciidoc API docs.\r\n\r\nNOTE: The api-kibana variable is defined in version-specific files. In\r\n[8.15.asciidoc](873ec2c47f/shared/versions/stack/8.x.asciidoc (L75)),\r\nthe variable points to the [v8\r\nbranch](https://www.elastic.co/docs/api/doc/kibana/v8) of the API\r\nreference, which currently doesn't include Security API docs. The v8\r\nbranch is derived from the \"current\" Kibana branch, which is currently\r\n8.15. This likely means that we can only backport the callouts to 8.16\r\nonce 8.16 becomes the \"current\" docs version.\r\n\r\nPreview: [Osquery manager\r\nAPI](https://kibana_bk_195909.docs-preview.app.elstc.co/guide/en/kibana/master/osquery-manager-api.html)\r\nand all its child pages","sha":"f0f17756324836e00ae0440ed1ba34c90490e843"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
92 lines
2.5 KiB
Text
92 lines
2.5 KiB
Text
[[osquery-manager-saved-queries-api-create]]
|
|
=== Create saved query API
|
|
++++
|
|
<titleabbrev>Create saved query</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[] Create saved queries.
|
|
|
|
|
|
[[osquery-manager-saved-queries-api-create-request]]
|
|
==== Request
|
|
|
|
`POST <kibana host>:<port>/api/osquery/saved_queries`
|
|
|
|
`POST <kibana host>:<port>/s/<space_id>/api/osquery/saved_queries`
|
|
|
|
|
|
[[osquery-manager-saved-queries-api-create-path-params]]
|
|
==== Path parameters
|
|
|
|
`space_id`::
|
|
(Optional, string) The space identifier. When `space_id` is not provided in the URL, the default space is used.
|
|
|
|
|
|
[[osquery-manager-saved-queries-api-create-body-params]]
|
|
==== Request body
|
|
|
|
`id`:: (Required, string) The saved query name.
|
|
|
|
`description`:: (Optional, string) The saved query description.
|
|
|
|
`platform`:: (Optional, string) Restricts the query to a specified platform. The default is 'all' platforms. To specify multiple platforms, use commas. For example, 'linux,darwin'.
|
|
|
|
`query`:: (Required, string) The SQL query you want to run.
|
|
|
|
`version`:: (Optional, string) Uses the Osquery versions greater than or equal to the specified version string.
|
|
|
|
`interval`:: (Optional, string) An interval, in seconds, on which to run the query.
|
|
|
|
`ecs_mapping`:: (Optional, object) Maps Osquery results columns or static values to ECS fields.
|
|
|
|
`timeout`:: (Optional, number) A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is `60`. The maximum supported value is `900`.
|
|
|
|
|
|
[[osquery-manager-saved-queries-api-create-request-codes]]
|
|
==== Response code
|
|
|
|
`200`::
|
|
Indicates a successful call.
|
|
|
|
|
|
[[osquery-manager-saved-queries-api-create-example]]
|
|
==== Examples
|
|
|
|
Create a saved query:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
$ curl -X POST api/osquery/saved_queries \
|
|
{
|
|
"id": "saved_query_id",
|
|
"description": "Saved query description",
|
|
"query": "select * from uptime;",
|
|
"interval": "60",
|
|
"timeout": 120,
|
|
"version": "2.8.0",
|
|
"platform": "linux,darwin",
|
|
"ecs_mapping": {
|
|
"host.uptime": {
|
|
"field": "total_seconds"
|
|
}
|
|
}
|
|
}
|
|
|
|
--------------------------------------------------
|
|
// KIBANA
|
|
|
|
|
|
The API returns the saved query object:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
{
|
|
"data": {...}
|
|
}
|
|
--------------------------------------------------
|