Noah Talerman and Rachael Shaw
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
+3
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
+1
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 and Rachael Shaw
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 and Rachael Shaw
a5978d16d9
YAML files: Add missing key ( #33574 )
...
Co-authored-by: Rachael Shaw <r@rachael.wtf >
2025-09-30 18:09:58 -05:00
Noah Talerman and Rachael Shaw
65989fbfc6
API reference: Which software supports last_opened ( #33459 )
...
Context:
https://github.com/fleetdm/fleet/issues/31268#issuecomment-3319200507
---------
Co-authored-by: Rachael Shaw <r@rachael.wtf >
2025-09-26 12:37:36 -05:00
Noah Talerman
375d7e8046
API reference: Which software supports hash_sha256 ( #33506 )
...
Context:
2025-09-26 12:35:42 -05:00
Marko Lisica
ba43b23a20
Remove object that's not implemented ( #33156 )
...
This is mistakenly documented. Probably this got deprioritized at some
point.
2025-09-18 16:52:08 -05:00
Rachael Shaw
35eaf7dec5
#29609 API design (add IdP department to host vitals) ( #30054 )
...
For #29609
> TODO: check whether IdP data is on "My device" page, and add to
documentation if so
2025-09-11 11:52:42 -05:00
Noah Talerman
ad68c67874
API reference: Fix broken anchor link ( #32687 )
2025-09-09 17:59:50 -05:00
Jonathan Katz
8c66ebbc2f
Update packages_only flag in rest-api.md ( #32359 )
...
### why
team_id is a Fleet Premium feature, and packages_only only works with
team_id set, so it should be marked as Fleet Premium too.
#31581
2025-09-09 17:15:43 -05:00
+2
2a901105bf
Docs v4.73.0 ( #32682 )
...
Documentation changes for the 4.73.0 release
---------
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: Ian Littman <iansltx@gmail.com >
Co-authored-by: Victor Lyuboslavsky <2685025+getvictor@users.noreply.github.com >
Co-authored-by: Gabriel Hernandez <ghernandez345@gmail.com >
Co-authored-by: Magnus Jensen <magnus@fleetdm.com >
Co-authored-by: RachelElysia <rachel@fleetdm.com >
Co-authored-by: RachelElysia <71795832+RachelElysia@users.noreply.github.com >
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com >
Co-authored-by: Scott Gress <scottmgress@gmail.com >
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com >
2025-09-08 19:09:44 -05:00
Rachael Shaw and jacobshandling
bf23533b35
#28390 API design (schedule script) ( #30443 )
...
For https://github.com/fleetdm/fleet/issues/28390
---------
Co-authored-by: jacobshandling <61553566+jacobshandling@users.noreply.github.com >
2025-09-08 17:47:56 -05:00
Noah Talerman
e06fa6bd07
API reference: Fix broken links ( #32510 )
2025-09-05 13:11:01 -05:00
Noah Talerman
3a6ef84b82
Revert API reference ( #32407 )
...
- @noahtalerman: We shipped https://github.com/fleetdm/fleet/pull/29956
into but we haven't shipped the user story yet:
- #29727
So that changes aren't actually live in Fleet.
2025-09-02 14:40:36 -05:00
Ian Littman and Rachael Shaw
d7b7ba4c61
Document binary hash visibility in host software API endpoint ( #32243 )
...
This was added a few fleetd/Fleet server releases ago; lack of docs was
an oversight at that point.
---------
Co-authored-by: Rachael Shaw <r@rachael.wtf >
2025-08-26 18:00:03 -05:00
Noah Talerman
beb6113732
GitOps reference: Add missing smtp_settings ( #32301 )
...
Addresses this bug: https://github.com/fleetdm/fleet/issues/29815
More history/context in this PR:
https://github.com/fleetdm/fleet/pull/29346
2025-08-26 17:58:59 -05:00
Rachael Shaw
03d2a854b7
#23899 API and YAML design (IdP department/group labels) ( #30015 )
...
For #23899
2025-08-20 11:28:36 -04:00
Marko Lisica
815e745917
[Docs] Document behavior of last_opened_at across different platforms ( #31958 )
...
Related to:
- #29061
2025-08-15 11:12:05 -05:00
6b37527c8a
4.72.0 doc changes ( #31766 )
...
Documentation changes for 4.72.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: Victor Lyuboslavsky <2685025+getvictor@users.noreply.github.com >
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com >
Co-authored-by: Ian Littman <iansltx@gmail.com >
Co-authored-by: RachelElysia <71795832+RachelElysia@users.noreply.github.com >
Co-authored-by: Noah Talerman <noahtal@umich.edu >
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com >
2025-08-13 19:10:48 -05:00
Marko Lisica
743c510e84
Docs bug: software_title_id is not available in GET /software/title/:id ( #31815 )
...
`software_title_id` field is documented, but not available in API.
2025-08-13 18:00:25 -05:00
Lucas Manuel Rodriguez
ca17e88db0
Add missing sso 4.71.0 api change ( #31656 )
...
We missed adding the API changes (new HTTP cookie added for security
hardening) for the SSO APIs in v4.71.0.
PS: Also took the chance at fixing a couple of typos.
2025-08-07 16:30:08 -05:00
Rachael Shaw
a19c2f7669
Fix "Get batch script summary" docs ( #31609 )
...
The `batch_execution_id` is in the path, not the request body.
2025-08-05 12:02:03 -05:00
Victor Lyuboslavsky
949a1eeabb
Add sso_server_url configuration for dual URL SSO setups ( #31497 )
...
This change allows configuring a separate URL for SSO callbacks, which
is useful when organizations have different URLs for admin access vs
agent/API access.
Fixes #31480 the SSO issue where organizations with dual URL setups were
getting 'Destination does not match requested URL' errors after
upgrading to v4.71.0 with the new SAML library.
Video demo: https://www.youtube.com/watch?v=dFzNpUY3XKI
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [x] 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.
## Testing
- [x] Added/updated automated tests
- [ ] QA'd all new/changed functionality manually
## New Fleet configuration settings
- [x] Verified that the setting is exported via `fleetctl
generate-gitops`
- [x] 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 )
- Same PR since this is going to be a 4.71.1 patch
- [ ] 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)
- [x] Verified that any relevant UI is disabled when GitOps mode is
enabled
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
## Summary by CodeRabbit
* **New Features**
* Added support for configuring a dedicated SSO URL, allowing
organizations to restrict SSO authentication to a specific URL.
* The new SSO URL option is available in both the UI and API
configuration settings.
* **Documentation**
* Updated configuration and API documentation to include the new SSO URL
option with usage examples.
* **Bug Fixes**
* Resolved authentication issues for organizations using separate URLs
for admin and agent/API access.
* **Tests**
* Added new unit and integration tests to verify SSO behavior with and
without the dedicated SSO URL.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-08-01 20:32:15 +02:00
Noah Talerman
fe7a91bf52
[API and YAML design] SSO breaks when using separate 'admin' URL ( #31513 )
...
API and YAML changes for the following bug:
- #31480
2025-08-01 10:44:12 -05:00
Noah Talerman
067f9560cc
API reference: Remove "browser" ( #31486 )
...
- @noahtalerman: When poking around in dogfood, I noticed that
`"browser"` is only included if the software item is a browser
extension. Otherwise it's excluded (not an empty string).
2025-07-31 18:01:11 -05:00
Noah Talerman
c807b4173f
API reference: Add missing link ( #31230 )
...
Context:
https://github.com/fleetdm/fleet/pull/31200#discussion_r2226730130
2025-07-29 17:25:25 -05:00
Ian Littman
beba3278d9
Fix docs to refer to "hash_sha256" as field name on software packages ( #31175 )
...
This matches the implementation (and a version of the spec that I
thought got merged).
2025-07-29 17:24:41 -05:00
fb7bcc1335
Reference docs: what happens when you change the Fleet web address ( #30999 )
...
- @noahtalerman: I think changing the Fleet web address means you'll
have to re-enroll all your hosts.
- We have a [feature
request](https://github.com/fleetdm/fleet/issues/29878 ) to add this copy
to the UI but I think we want to get this in the docs ASAP
---------
Co-authored-by: Victor Lyuboslavsky <2685025+getvictor@users.noreply.github.com >
Co-authored-by: Rachael Shaw <r@rachael.wtf >
2025-07-29 14:10:04 -05:00
0d8c099cf9
Docs v4.71.0 ( #31200 )
...
Documentation changes for 4.71.0
---------
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com >
Co-authored-by: Jordan Montgomery <elijah.jordan.montgomery@gmail.com >
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com >
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com >
Co-authored-by: Ian Littman <iansltx@gmail.com >
2025-07-23 16:02:13 -06:00
54c3361bc1
Docs v4.70.0 ( #30432 )
...
Documentation changes for the 4.70.0 release.
---------
Co-authored-by: Ian Littman <iansltx@gmail.com >
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com >
Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com >
Co-authored-by: Martin Angers <martin.n.angers@gmail.com >
Co-authored-by: Scott Gress <scottmgress@gmail.com >
2025-06-30 16:33:32 -05:00
RachelElysia
05037f9ea0
Fleet Docs: Update /hosts/:id/software API docs to reflect available params ( #30123 )
...
## Description
- Copied verbatim from REST API docs for `GET /software` params
2025-06-25 17:44:50 -05:00
Juan Fernandez
b31d5f9bba
Misc feedback for new Windows doWipe cmd ( #30252 )
...
For #21979
A couple of small items that came up during the first round of QA
2025-06-25 18:38:40 -04:00
Rachael Shaw
8641657686
Revert #27457 API changes (default avatar for API-only user) ( #30051 )
...
https://github.com/fleetdm/fleet/issues/27457 did not make it into a
sprint and docs were not removed.
2025-06-16 12:18:01 -05:00
Rachael Shaw
ac16428f3c
4.69.0 doc changes ( #28937 )
2025-06-14 14:26:45 -05:00
Ian Littman and Noah Talerman
6f772a4405
Clean up "here" link anchors for docs, ee, and frontend dirs ( #29742 )
...
More work to fix #29720 .
---------
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com >
2025-06-13 15:05:52 -05:00
Brock Walters
daca0e7b17
Update Hosts endpoint list in rest-api.md ( #29972 )
...
Added #resend-hosts-configuration-profile link in Host endpoint list.
Why are these in this order? What is the order scheme? Thanks.
2025-06-12 17:49:32 -04:00
Juan Fernandez and Rachael Shaw
d847ec8ed4
21979: Extended wipe end-point to allow for doWipe Win CMD ( #29770 )
...
For #21979
Extended POST /api/v1/fleet/hosts/:id/wipe end-point to allow users to
specify an optional payload for specifying what type of remote wipe to
perform on Win hosts.
---------
Co-authored-by: Rachael Shaw <r@rachael.wtf >
2025-06-11 13:56:07 -04:00
Rachael Shaw
213a5b082f
API docs: Miscellaneous minor formatting fixes ( #29627 )
...
+ For `order_direction`, use consistent `"asc"` and `"desc"` instead of
'asc', `asc`, etc.
+ Add a missing comma in an example
+ Add missing quotes for a string value in an example
2025-05-30 12:16:43 -05:00
Noah Talerman and Rachael Shaw
afdfe94dd6
API docs: add missing parameters ( #29446 )
...
- Get host's software
---------
Co-authored-by: Rachael Shaw <r@rachael.wtf >
2025-05-30 11:05:01 -05:00
Noah Talerman
7cf2e2de47
[API design] Add a new timestamp for MDM check-in ( #29467 )
...
Original PR [here](https://github.com/fleetdm/fleet/pull/28940 ) was made
to 4.69.0 reference docs branch but the [user
story](https://github.com/fleetdm/fleet/issues/17710 ) was shipped in
4.68.
2025-05-27 17:33:48 -05:00
