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
105 lines
2.2 KiB
Text
105 lines
2.2 KiB
Text
[[osquery-manager-packs-api-create]]
|
||
=== Create pack API
|
||
++++
|
||
<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.
|
||
|
||
|
||
[[osquery-manager-packs-api-create-request]]
|
||
==== Request
|
||
|
||
`POST <kibana host>:<port>/api/osquery/packs`
|
||
|
||
`POST <kibana host>:<port>/s/<space_id>/api/osquery/packs`
|
||
|
||
|
||
[[osquery-manager-packs-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-packs-api-create-body-params]]
|
||
==== Request body
|
||
|
||
`name`:: (Required, string) The pack name.
|
||
|
||
`description`:: (Optional, string) The pack description.
|
||
|
||
`enabled`:: (Optional, boolean) Enables the pack.
|
||
|
||
`policy_ids`:: (Optional, array) A list of agents policy IDs.
|
||
|
||
`shards`:: (Optional, object) An object with shard configuration for policies included in the pack. For each policy, set the shard configuration to a percentage (1–100) of target hosts.
|
||
|
||
`queries`:: (Required, object) An object of queries.
|
||
|
||
|
||
[[osquery-manager-packs-api-create-request-codes]]
|
||
==== Response code
|
||
|
||
`200`::
|
||
Indicates a successful call.
|
||
|
||
|
||
[[osquery-manager-packs-api-create-example]]
|
||
==== Examples
|
||
|
||
Create a pack:
|
||
|
||
[source,sh]
|
||
--------------------------------------------------
|
||
$ curl -X POST api/osquery/packs \
|
||
{
|
||
"name": "my_pack",
|
||
"description": "My pack",
|
||
"enabled": true,
|
||
"policy_ids": [
|
||
"my_policy_id",
|
||
"fleet-server-policy"
|
||
],
|
||
"shards": {
|
||
"my_policy_id": 35,
|
||
"fleet-server-policy": 58
|
||
},
|
||
"queries": {
|
||
"my_query": {
|
||
"query": "SELECT * FROM listening_ports;",
|
||
"interval": 60,
|
||
"timeout": 120,
|
||
"ecs_mapping": {
|
||
"client.port": {
|
||
"field": "port"
|
||
},
|
||
"tags": {
|
||
"value": [
|
||
"tag1",
|
||
"tag2"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
--------------------------------------------------
|
||
// KIBANA
|
||
|
||
|
||
The API returns the pack object:
|
||
|
||
[source,sh]
|
||
--------------------------------------------------
|
||
{
|
||
"data": {...}
|
||
}
|
||
--------------------------------------------------
|