Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-22 08:28:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 107
fleet/docs
History
jacobshandling 1268036c1f
23971 Proposed API and schema changes (#25013) 
## For #25034

### API changes:
[this PR diff](https://github.com/fleetdm/fleet/pull/25013/files)
("available_teams" change is adding missing documentation for current
API behavior)

### schema changes:
- new col in `users` table, `settings`, type `json`. Defaults to `{}`.
New setting, `hidden_host_columns`, added or updated on first relevant
API call per user.

### semantics

- **null** `"hidden_host_columns"` field means "not yet set, use
defaults": `{"settings":{"hidden_host_columns": null}}`
- **included and empty** `"hidden_host_columns"` field means "no columns
hidden, show all columns in the UI":
`{"settings":{"hidden_host_columns": []}}`

### Updates 1/7/25 per discussion with @rachaelshaw @lucasmrod
@sgress454:
- Optional query param `include_ui_settings=true` included with `GET`s
to `/me` or `/users/:id` will trigger considering the API call to be a
contributor API call, giving more flexibility for future changes. Note
that this is the first time we have one endpoint that can be
conditionally considered a contributor endpoint depending on how it is
called.

---------

Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
2025-03-10 10:17:57 -07:00
..
01-Using-Fleet/standard-query-library Website: add bash commands for macOS vitals, queries, and policies (#26327) 2025-02-20 18:16:16 -06:00
Configuration Update yaml-files.md (#26781) 2025-03-06 17:34:44 -06:00
Contributing 23971 Proposed API and schema changes (#25013) 2025-03-10 10:17:57 -07:00
Deploy Update Reference-Architectures.md (#26702) 2025-02-28 14:35:05 -06:00
files Handbook: Adding 2024 pen test document to security audit page (#21393) 2024-08-21 11:15:37 -04:00
Get started Update tutorials-and-guides.md (#26900) 2025-03-06 10:57:11 -06:00
images Add files via upload to replace old screenshot for SSO config (#26841) 2025-03-06 13:28:57 -06:00
REST API 23971 Proposed API and schema changes (#25013) 2025-03-10 10:17:57 -07:00
Using Fleet Docs quick reference optimization (#21331) 2024-08-16 15:30:31 -05:00
queries.yml Update queries.yml (#26682) 2025-02-27 18:16:46 -06:00
README.md Updated broken links for Using Fleet and Deploying (#20655) 2024-07-25 10:04:18 -04:00

README.md

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.