[DOCS ]Direct users to new API reference site (#195909)

## 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
This commit is contained in:
natasha-moore-elastic 2024-10-15 16:29:05 +01:00 committed by GitHub
parent fe22ac9928
commit f0f1775632
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 90 additions and 0 deletions

View file

@ -1,6 +1,12 @@
[[osquery-manager-api]]
== Osquery manager API
.New API Reference
[sidebar]
--
For the most up-to-date API details, refer to {api-kibana}/group/endpoint-security-osquery-api[Osquery APIs].
--
experimental[] Run live queries, manage packs and saved queries
Use the osquery manager APIs for managing packs and saved queries.

View file

@ -4,6 +4,12 @@
<titleabbrev>Create live 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 live queries.

View file

@ -4,6 +4,12 @@
<titleabbrev>Get live queries</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[] Get live queries.

View file

@ -4,6 +4,12 @@
<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.

View file

@ -4,6 +4,12 @@
<titleabbrev>Get live 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[] Retrieves a single live query by ID.

View file

@ -4,6 +4,12 @@
<titleabbrev>Create pack</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 packs.

View file

@ -4,6 +4,12 @@
<titleabbrev>Delete pack</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[] Delete packs.
WARNING: Once you delete a pack, _it cannot be recovered_.

View file

@ -4,6 +4,12 @@
<titleabbrev>Get packs</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[] Get packs.

View file

@ -4,6 +4,12 @@
<titleabbrev>Get pack</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 pack by ID.

View file

@ -4,6 +4,12 @@
<titleabbrev>Update pack</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[] Update packs.
WARNING: You are unable to update a prebuilt pack (`read_only = true`).

View file

@ -4,6 +4,12 @@
<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.

View file

@ -4,6 +4,12 @@
<titleabbrev>Delete 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[] Delete saved queries.
WARNING: Once you delete a saved query, _it cannot be recovered_.

View file

@ -4,6 +4,12 @@
<titleabbrev>Get saved-queries</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[] Get saved queries.

View file

@ -4,6 +4,12 @@
<titleabbrev>Get 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[] Retrieve a single saved query by ID.

View file

@ -4,6 +4,12 @@
<titleabbrev>Update 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[] Update saved queries.
WARNING: You are unable to update a prebuilt saved query (`prebuilt = true`).