Files
fleet/docs
Luke Heath 77e090f71b Fix broken JSON examples, response docs, and parameter tables in REST API reference (#50457)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->

## Summary

While working on a parser for the REST API docs, I found a number of
broken spots in the reference. This PR fixes them. They all affect human
readers too (invalid JSON in examples, missing response documentation,
broken tables).

- Fixed invalid JSON in 28 response examples (trailing commas, missing
braces, stray tokens, `...` placeholders inside JSON).
- Added missing `Default response` documentation to 6 endpoints. Status
codes and body shapes were verified against the Go handlers rather than
inferred.
- Added missing `Status:` lines to 4 response blocks. One is a
correction: `Rotate host's Recovery Lock password` was documented as
returning `204`, but the server returns `200` (its response struct has
no `Status()` override).
- Fixed 3 malformed parameter tables (wrong column counts, one missing
`In` value).
- Restored the standard request line in `Get script result`.
- Corrected the dual-key token examples (`abm_tokens`/`ab_tokens`,
`teams`/`fleets`): the nested team objects use `team_id` in legacy
containers and `fleet_id` in renamed containers on the wire, not bare
`id`.

# Checklist for submitter

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

- [x] Manual QA for all new/changed functionality

### Test plan

- Every JSON example touched by this PR was mechanically validated
(valid JSON after stripping `//` comment annotations).
- Added response blocks and status codes were checked against the Go
handlers (response structs and `Status()` methods).
- The full document was run through the parser to confirm every endpoint
section now reads cleanly.
2026-08-03 17:00:22 -05:00
..
2026-07-22 17:22:30 -05: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.