From 4ac1be34d9a07d6ff4d97b744abf0a7716fa8664 Mon Sep 17 00:00:00 2001 From: Scott Gress Date: Wed, 22 Jan 2025 13:15:31 -0600 Subject: [PATCH] Update docs for host_batch_size (#25632) for #24967 This PR updates the documentation for the `host_batch_size` for both the failing policies webhook and the vulnerabilities webhook. The new documentation matches the actual behavior when `host_batch_size` is set to 0. --- docs/Configuration/yaml-files.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/Configuration/yaml-files.md b/docs/Configuration/yaml-files.md index ffec778328b3..f5be30ff1eb9 100644 --- a/docs/Configuration/yaml-files.md +++ b/docs/Configuration/yaml-files.md @@ -590,7 +590,7 @@ org_settings: - `enable_failing_policies_webhook` (default: `false`) - `destination_url` is the URL to `POST` to when the condition for the webhook triggers (default: `""`). - `policy_ids` is the list of policies that will trigger a webhook. -- `host_batch_size` is the maximum number of hosts to batch in each webhook. A value of `0` means no batching (default: `0`). +- `host_batch_size` is the maximum number of host identifiers to send in one webhook request. A value of `0` means all host identifiers with a failing policy will be sent in a single request. #### Example @@ -630,8 +630,7 @@ org_settings: - `enable_vulnerabilities_webhook` (default: `false`) - `destination_url` is the URL to `POST` to when the condition for the webhook triggers (default: `""`). -- `days_count` is the number of days that hosts need to be offline to count as part of the percentage (default: `0`). -- `host_batch_size` is the maximum number of hosts to batch in each webhook. A value of `0` means no batching (default: `0`). +- `host_batch_size` is the maximum number of host identifiers to send in one webhook request. A value of `0` means all host identifiers with a detected vulnerability will be sent in a single request. #### Example