Discharge7443/fleet
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity

Documentation for query_report_cap config (#20414)

Browse Source 
- Add documentation for the `query_report_cap` config option. For #19600
This commit is contained in:
Rachael Shaw
2024-07-15 14:10:34 -04:00
committed by GitHub
parent 5cc5e527e5
commit e4044c5d63
2 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/REST API/rest-api.md
+2
View File
@@ -1340,6 +1340,7 @@ Modifies the Fleet's configuration with the supplied information.
| live_query_disabled | boolean | Whether the live query capabilities are disabled. |
| query_reports_disabled | boolean | Whether query report capabilities are disabled. |
| ai_features_disabled | boolean | Whether AI features are disabled. |
| query_report_cap | integer | The maximum number of results to store per query report before the report is clipped. If increasing this cap, we recommend enabling reports for one query at time and monitoring your infrastructure. (Default: `1000`) |
<br/>
@@ -7326,6 +7327,7 @@ Returns the query report specified by ID.
```json
{
"query_id": 31,
"report_clipped": false,
"results": [
{
"host_id": 1,
docs/Using Fleet/GitOps.md
+1
View File
@@ -366,6 +366,7 @@ org_settings:
- `enable_analytics` specifies whether or not to enable Fleet's [usage statistics](https://fleetdm.com/docs/using-fleet/usage-statistics) (default: `true`).
- `live_query_disabled` disables the ability to run live queries (ad hoc queries executed via the UI or fleetctl) (default: `false`).
- `query_reports_disabled` disables query reports and deletes existing repors (default: `false`).
- `query_report_cap` sets the maximum number of results to store per query report before the report is clipped. If increasing this cap, we recommend enabling reports for one query at time and monitoring your infrastructure. (Default: `1000`)
- `scripts_disabled` blocks access to run scripts. Scripts may still be added in the UI and CLI (defaul: `false`).
- `server_url` is the base URL of the Fleet instance (default: provided during Fleet setup)