Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Adds shards object to Create pack and Update pack API #166363

Merged
merged 1 commit into from
Sep 18, 2023
Merged

[DOCS] Adds shards object to Create pack and Update pack API #166363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions docs/api/osquery-manager/packs/create.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ experimental[] Create packs.

`policy_ids`:: (Optional, array) A list of agents policy IDs.

`shards`:: (Required, 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.


Expand All @@ -56,8 +58,13 @@ $ curl -X POST api/osquery/packs \
"description": "My pack",
"enabled": true,
"policy_ids": [
"my_policy_id"
"my_policy_id",
"fleet-server-policy"
],
"shards": {
"my_policy_id": 35,
"fleet-server-policy": 58
},
"queries": {
"my_query": {
"query": "SELECT * FROM listening_ports;",
Expand All @@ -67,7 +74,10 @@ $ curl -X POST api/osquery/packs \
"field": "port"
},
"tags": {
"value": ["tag1", "tag2"]
"value": [
"tag1",
"tag2"
]
}
}
}
Expand Down
2 changes: 2 additions & 0 deletions docs/api/osquery-manager/packs/update.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ WARNING: You are unable to update a prebuilt pack (`read_only = true`).

`policy_ids`:: (Optional, array) A list of agent 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.


Expand Down
Loading