fleet/docs
Dale Ribeiro 168d41a773
Update rest-api with additional_queries correction.md (#29184)
The additional_queries property in the modify configuration endpoint is
not a boolean. It should be an object that contains a key/value pair
with the name of the query and the query itself. I updated the
description and example to reflect this and match what we have in our
GitOps docs: https://fleetdm.com/docs/configuration/yaml-files#features

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [ ] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [ ] Added/updated automated tests
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/fleetd-development-and-release-strategy.md)).
- [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
- [ ] For unreleased bug fixes in a release candidate, confirmed that
the fix is not expected to adversely impact load test results or alerted
the release DRI if additional load testing is needed.
2025-05-20 13:13:25 -05:00
..
01-Using-Fleet/standard-query-library Apple Intelligence enabled? (#27866) 2025-04-07 18:40:37 -05:00
Configuration Organize contributor docs and establish ADR process and template (#29101) 2025-05-17 15:03:52 -05:00
Contributing Update contrib docs headers to sentence case (#29276) 2025-05-20 11:26:35 -05:00
Deploy Docs: Fix urls of two images on SSO page (#28990) 2025-05-08 17:30:28 -05:00
files Handbook: Adding 2024 pen test document to security audit page (#21393) 2024-08-21 11:15:37 -04:00
Get started Bumping MySQL 8.4.3->8.4.5 and 9.1.0->9.3.0 in tests. (#28767) 2025-05-02 13:40:11 -05:00
images Update single-sign-on-sso.md (#27784) 2025-04-04 18:04:18 -05:00
REST API Update rest-api with additional_queries correction.md (#29184) 2025-05-20 13:13:25 -05:00
Using Fleet Docs quick reference optimization (#21331) 2024-08-16 15:30:31 -05:00
queries.yml Docs: Update macOS software host vital query (#29139) 2025-05-15 18:26:35 -05:00
README.md Updated broken links for Using Fleet and Deploying (#20655) 2024-07-25 10:04:18 -04:00

Fleet documentation

Welcome to the documentation for Fleet, the lightweight management platform for laptops and servers.

You can also read the Fleet docs over at https://fleetdm.com/docs.

Using Fleet

Resources for using the Fleet UI, fleetctl CLI, and Fleet REST API.

Deploying

Resources for installing Fleet's infrastructure dependencies, configuring Fleet, deploying osquery to hosts, and viewing example deployment scenarios.

Contributing

If you're interested in interacting with the Fleet source code, you'll find information on modifying and building the code here.


If you have any questions, please don't hesitate to File a GitHub issue or join us on Slack. You can find us in the #fleet channel.