Commit graph

344 commits

Author SHA1 Message Date
Marko Lisica
b8c342d5c0
Explain what is enrollment ID for personal hosts (#38829) 2026-01-27 16:10:42 -06:00
Noah Talerman
0c3293dd3c
API reference: Human friendly docs for API endpoints that take multipart/form-data (#37674)
- During Product office hours on 2025-12-23, we learned that no one on
the call knew what the current request body format was for API endpoints
that take `multipart/form-data`
- We think the updated format is more friendly for humans who are using
curl/Postman
- We later learned that this the current format is the raw request
(formatted by a browser or curl command)
- Also update "form" to "body" in the "Parameters" table. We learned
that the form data is actually part the body. Postman's UI shows this.
2026-01-26 15:22:24 -05:00
Martin Angers
9db733a5dc
Clarify when the browser field is included, along with the extension_for field (#38494)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #31519
2026-01-19 16:08:25 -06:00
Noah Talerman
c1e2b637f9
API and YAML reference: Add missing interval field for policy automations (#38382)
How we learned we were missing these:
https://github.com/fleetdm/fleet/pull/38325#discussion_r2691714596

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
2026-01-16 15:19:21 -06:00
Rachael Shaw
bcf5ebd019
Preview of v4.79.0 doc changes (#35930)
This PR will remain in draft as a preview of upcoming documentation
changes for 4.79.0

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Magnus Jensen <magnus@fleetdm.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: melpike <79950145+melpike@users.noreply.github.com>
Co-authored-by: Steven Palmesano <3100993+spalmesano0@users.noreply.github.com>
Co-authored-by: Carlo <1778532+cdcme@users.noreply.github.com>
2026-01-14 14:47:06 -06:00
Konstantin Sykulev
b728d7a075
Adjusted certificate rest api docs with more details about auth header (#38134)
**Related issue:** #35198

Making the docs clearly specify what node key and bearer do to the api
responses.
2026-01-12 15:45:22 -06:00
Noah Talerman
e132c758a8
API reference: Cleanup (#38190)
- Acronym was mentioned twice
2026-01-12 14:48:25 -06:00
Rachael Shaw
ca2fa91477
API docs: Fix parameter type (#37956)
Looks like a copy/paste issue we never caught
2026-01-06 17:35:19 -06:00
Rachael Shaw
091c8bbbd3
API docs: Typo fix (#37954)
Additional query parameters use `&` instead of `?`
2026-01-06 17:02:10 -06:00
Noah Talerman
5b41bb4c53
API reference: GET /commands default page length and sort (#37899)
These undocumented defaults cause confusion:
https://github.com/fleetdm/fleet/issues/32785#issuecomment-3715226225
2026-01-06 11:14:31 -06:00
Noah Talerman
c0c54ca1f8
API docs typo: Change labels and configuration fields to body (#37656) 2025-12-23 14:06:55 -06:00
Noah Talerman
e1aded2e49
Use "array" instead of "string[]" (#37655)
To be consistent
2025-12-23 14:04:29 -06:00
Marko Lisica
59f318c77a
Clarify platform filter description in API docs (#36618)
Related to:

- #34072
2025-12-22 12:58:20 -06:00
Jonathan Katz
5750e4393a
Docs change: GET setup_experience/software allows comma separated values (#37499)
**Related issue:** #35554 

Ability to add multiple `platform` values is added to "List setup
experience software" (`GET api/v1/fleet/setup_experience/software`) in
PR #37468. This change is similar to how `platform` can be set in the
"List software" endpoint (`GET /api/v1/fleet/software/titles`).

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2025-12-22 13:25:19 -05:00
Rachael Shaw
45b162f940
Preview of v4.78.0 doc changes (#35929) 2025-12-19 17:07:58 -06:00
Steven Palmesano
7530a0a55c
Remove link to "Get host's Google Chrome profiles" (#37132)
This doesn't exist any more
2025-12-11 12:34:32 -06:00
Marko Lisica
5137f6b6cd
Remove params from activities API (#36687)
This is pushed to 4.78
2025-12-04 16:02:10 -06:00
Rachael Shaw
25191f3054
Preview of v4.77.0 doc changes (#35924)
This PR will remain in draft as a preview of upcoming documentation
changes for 4.77.0

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Victor Lyuboslavsky <2685025+getvictor@users.noreply.github.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Noah Talerman <noahtal@umich.edu>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Magnus Jensen <magnus@fleetdm.com>
Co-authored-by: Jordan Montgomery <elijah.jordan.montgomery@gmail.com>
Co-authored-by: Janis Watts <184028114+jmwatts@users.noreply.github.com>
Co-authored-by: Allen Houchins <32207388+allenhouchins@users.noreply.github.com>
Co-authored-by: Gabriel Hernandez <ghernandez345@gmail.com>
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
Co-authored-by: Scott Gress <scottmgress@gmail.com>
Co-authored-by: Carlo <1778532+cdcme@users.noreply.github.com>
2025-12-02 17:24:15 -06:00
Steven Palmesano
e6a5aafd1f
Change "ad-hoc" to "ad hoc" (#36549)
These are two (Latin) words, they should not be hyphenated. Found
because I was trying to use command + f to search for "ad hoc," since
that's the proper spelling.
2025-12-02 15:55:43 -06:00
Rachael Shaw
cb621bdfef
[UPDATED] #31719 API/YAML design (Add custom package that only contains a script) (#33648) 2025-11-26 16:43:31 -06:00
Marko Lisica
23b60d79d5
[Docs bug] team_id is not required (#36269)
Clarified the description of the 'team_id' parameter in the API
documentation. If not set default is no team
2025-11-26 12:23:52 -06:00
Steven Palmesano
03e8a35854
Fix link to Download bootstrap package (#35300) 2025-11-20 11:16:44 -06:00
Magnus Jensen
e4fbc4fb6e
Fix table of content links on Rest API page (#35348)
Fixes the outdated MDM link, and adds the missing top-level links.

_The notation for integrations `#integrations-1`, is to take the second
occurence of integrations, as we have another integrations title in the
update webhook configuration._

I can see this doesn't affect the website (or shouldn't) since it uses
it's own way to generate the TOC, but will help for manually browsing
the markdown.
2025-11-20 11:16:20 -06:00
Rachael Shaw
65fdb6ae40
API Docs: Add missing parameter in "Update configuration" (#36025)
`integrations` section was there but not linked in the main parameters
table.
2025-11-19 16:32:10 -06:00
Noah Talerman
521e8be95e
[API reference] Fix broken link (#35953) 2025-11-18 16:24:17 -06:00
Jordan Montgomery
64adfc1116
Remove new PUT endpoint, update docs for POST (#35820)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #35309 docs changes

For more context see
https://fleetdm.slack.com/archives/C019WG4GH0A/p1763137466439419

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2025-11-18 12:03:49 -06:00
Noah Talerman
6e635e7888
Delete Entra modal: Update instructions (#35874)
Deleting Microsoft Entra ID doesn't unblock end users. Instead, to
unblock, the IT admin has to disable the "Conditional Access" policy in
Entra.

Context: https://github.com/fleetdm/fleet/pull/35632/files#r2524534037
2025-11-18 06:45:24 -08:00
Victor Lyuboslavsky
a87a460de3
API changes for Okta conditional access (#35632) 2025-11-17 19:25:34 -06:00
Jordan Montgomery
98452d4827
[API/YAML] Docs for new setup experience script PUT endpoint (#35736)
API changes for #35309 

Also updates bug notes to call out fixed version.

Related PR #35651

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2025-11-14 17:47:34 -05:00
Rachael Shaw
a074498668
API design: #33758 (OS vulnerabilities bug) (#33533)
> This PR to be left in draft until bug is brought into a sprint, at
which point we'll close and re-open to the correct release branch.

Changes for the following bug:
+ https://github.com/fleetdm/fleet/issues/33758

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2025-11-14 16:58:00 -05:00
Jordan Moore
01298afe9c
REST API Human-device mapping table of contents correction (#35718)
Corrected REST API Documentation table of contents so that the `Update
human-device mapping` heading linked to the right location in the
document and the heading in the table of contents matches the actual
heading.
2025-11-13 17:58:36 -05:00
Rachael Shaw
3135e9a0a7
#30117 API/YAML design: Require all software installs during macOS setup experience (#33016)
User story:

+ #30117
2025-11-11 10:04:05 -05:00
Rachael Shaw
86b80e28ed
Documentation v4.76.0 (#34943)
Documentation changes for the 4.76 release
2025-11-11 09:30:14 -05:00
Steven Palmesano
41335e1ce7
Correct Create package to Add package (#35175) 2025-11-05 11:42:39 -06:00
Rachael Shaw
caeea404f0
Docs: Fix broken link (#35162) 2025-11-04 11:16:53 -06:00
Matt Rebelo
87a48c0653
Update rest-api.md (#34992)
Correcting description of action when no team is applied to fleet
premium when modifying OS settings.

https://fleetdm.slack.com/archives/C019WG4GH0A/p1761829754255319

<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #

# Checklist for submitter

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

- [ ] 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/guides/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)
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes

## Testing

- [ ] Added/updated automated tests
- [ ] Where appropriate, [automated tests simulate multiple hosts and
test for host
isolation](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/reference/patterns-backend.md#unit-testing)
(updates to one hosts's records do not affect another)

- [ ] QA'd all new/changed functionality manually

For unreleased bug fixes in a release candidate, one of:

- [ ] Confirmed that the fix is not expected to adversely impact load
test results
- [ ] Alerted the release DRI if additional load testing is needed

## 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`).

## New Fleet configuration settings

- [ ] Setting(s) is/are explicitly excluded from GitOps

If you didn't check the box above, follow this checklist for
GitOps-enabled settings:

- [ ] Verified that the setting is exported via `fleetctl
generate-gitops`
- [ ] Verified the setting is documented in a separate PR to [the GitOps
documentation](https://github.com/fleetdm/fleet/blob/main/docs/Configuration/yaml-files.md#L485)
- [ ] Verified that the setting is cleared on the server if it is not
supplied in a YAML file (or that it is documented as being optional)
- [ ] Verified that any relevant UI is disabled when GitOps mode is
enabled

## fleetd/orbit/Fleet Desktop

- [ ] Verified compatibility with the latest released version of Fleet
(see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/workflows/fleetd-development-and-release-strategy.md))
- [ ] If the change applies to only one platform, confirmed that
`runtime.GOOS` is used as needed to isolate changes
- [ ] Verified that fleetd runs on macOS, Linux and Windows
- [ ] Verified auto-update works from the released version of component
to the new version (see [tools/tuf/test](../tools/tuf/test/README.md))
2025-11-03 10:40:01 -06:00
Noah Talerman
7dc9604a5c
Consistent API language (#34878)
This language and in this order:
- List
  - For many items (ex. List host)
- Create
- Get
  - For one item (ex. Get host)
- Update
- Delete

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-10-29 12:30:02 -05:00
Jonathan Katz
bb512cc345
Documentation updates for in-house-app features (#34817)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #

# Checklist for submitter

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

- [ ] 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/guides/committing-changes.md#changes-files)
for more information.
2025-10-28 12:05:47 -05:00
Noah Talerman
2bc25471f6
API reference: Batch-modify profiles w/ 100+ profiles (#34853)
Requests take 5+ seconds

Context:
https://github.com/fleetdm/fleet/issues/32786#issuecomment-3456612158
2025-10-28 12:03:30 -05:00
Noah Talerman
b6348c505b
hash_sha256 is the cdhash_sha256 (#34822)
The `hash_sha256` from the [`/hosts/:id/software` Fleet
API](https://fleetdm.com/docs/rest-api/rest-api#get-hosts-software) is
an attribute that Santa can use to block applications:
https://northpole.dev/features/binary-authorization/#cdhash

https://fleetdm.com/tables/codesign:

<img width="894" height="449" alt="Screenshot 2025-10-27 at 1 49 29 PM"
src="https://github.com/user-attachments/assets/287750b5-ef38-4eba-aa8c-085520150be0"
/>
2025-10-27 17:05:48 -05:00
Jorge Falcon
084fd97578
Fix software icon links in REST API documentation (#34734) 2025-10-27 17:05:20 -05:00
Noah Talerman
7849306684
[API reference] Fix broken "filters" anchor link (#34608) 2025-10-22 14:55:47 -05:00
Rachael Shaw
7ed4aac2b8
Docs v4.75.0 (#34443)
Documentation changes for the 4.75 release

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Victor Lyuboslavsky <2685025+getvictor@users.noreply.github.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Noah Talerman <noahtal@umich.edu>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Magnus Jensen <magnus@fleetdm.com>
Co-authored-by: Jordan Montgomery <elijah.jordan.montgomery@gmail.com>
Co-authored-by: Tim Lee <timlee@fleetdm.com>
Co-authored-by: Janis Watts <184028114+jmwatts@users.noreply.github.com>
Co-authored-by: Sarah Gillespie <73313222+gillespi314@users.noreply.github.com>
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2025-10-17 17:45:52 -05:00
Mason Buettner
e78ad1b9ca
Fix typo in REST API "Request certificate" (#34092)
Changes:
 - Changed "isseud" to "issued" in `idp_client_id`.
2025-10-10 12:06:02 -05:00
Noah Talerman
9034d13b65
API reference: Clarify 'pending' (#33960) 2025-10-08 16:47:31 -04:00
Rachael Shaw
48cb0908cd
Docs v4.74.0 (#33879)
Documentation changes for 4.74

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Victor Lyuboslavsky <2685025+getvictor@users.noreply.github.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Noah Talerman <noahtal@umich.edu>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Magnus Jensen <magnus@fleetdm.com>
Co-authored-by: Jordan Montgomery <elijah.jordan.montgomery@gmail.com>
Co-authored-by: Janis Watts <184028114+jmwatts@users.noreply.github.com>
Co-authored-by: Allen Houchins <32207388+allenhouchins@users.noreply.github.com>
2025-10-06 17:03:10 -05:00
Noah Talerman
46df8f8274
API reference: Remove errant key (#33898) 2025-10-06 17:01:11 -05:00
Noah Talerman
5ee9fa774c
API reference: OTA profiles don't work if end user auth is enabled (#33705)
- @noahtalerman: We shipped a breaking change in Fleet 4.73 that
resulted in this bug: https://github.com/fleetdm/fleet/issues/33447
 - To fix this bug we decided to...
- Accept this breaking change, document it (this PR), and add an
improved error message. See
[bug](https://github.com/fleetdm/fleet/issues/33447).
- Improve the manual enrollment flow for macOS hosts. User story is
[here](https://github.com/fleetdm/fleet/issues/33640).
   - Both changes are targeted for 4.77
2025-10-02 19:05:09 -05:00
Allen Houchins
df0d60a8f4
Update rest-api.md (#33702)
- Added additional platform information to address confusion encountered
during a recent prospect call.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-10-02 18:48:16 -05:00
Noah Talerman
a5978d16d9
YAML files: Add missing key (#33574)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-09-30 18:09:58 -05:00