mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 19:13:14 -04:00
f0f1775632
## 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
51 lines
1.2 KiB
Text
51 lines
1.2 KiB
Text
[[osquery-manager-packs-api-delete]]
|
|
=== Delete pack API
|
|
++++
|
|
<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_.
|
|
|
|
|
|
[[osquery-manager-packs-api-delete-request]]
|
|
==== Request
|
|
|
|
`DELETE <kibana host>:<port>/api/osquery/packs/<id>`
|
|
|
|
`DELETE <kibana host>:<port>/s/<space_id>/api/osquery/packs/<id>`
|
|
|
|
|
|
[[osquery-manager-packs-api-delete-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.
|
|
|
|
`id`::
|
|
(Required, string) The ID of the pack you want to delete.
|
|
|
|
|
|
[[osquery-manager-packs-api-delete-response-codes]]
|
|
==== Response code
|
|
|
|
`200`::
|
|
Indicates that the pack is deleted. Returns an empty response body.
|
|
|
|
[[osquery-manager-packs-api-delete-example]]
|
|
==== Example
|
|
|
|
Delete a pack object with the `bbe5b070-0c51-11ed-b0f8-ad31b008e832` ID:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
$ curl -X DELETE api/osquery/packs/bbe5b070-0c51-11ed-b0f8-ad31b008e832
|
|
--------------------------------------------------
|
|
// KIBANA
|