Rachael Shaw
f73478248d
Docs: Fix API endpoint heading ( #42822 )
...
h4 -> h3
2026-04-01 12:03:57 -05:00
+1
1ad8b03337
Preview of v4.83.0 doc changes ( #39805 )
...
This PR will remain in draft as a preview of upcoming documentation
changes for 4.83.0
---------
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com >
Co-authored-by: Jordan Montgomery <elijah.jordan.montgomery@gmail.com >
Co-authored-by: melpike <79950145+melpike@users.noreply.github.com >
Co-authored-by: kiloconnect[bot] <240665456+kiloconnect[bot]@users.noreply.github.com>
Co-authored-by: Victor Lyuboslavsky <2685025+getvictor@users.noreply.github.com >
Co-authored-by: Scott Gress <scottmgress@gmail.com >
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com >
Co-authored-by: Jonathan Katz <44128041+jkatz01@users.noreply.github.com >
Co-authored-by: kilo-code-bot[bot] <240665456+kilo-code-bot[bot]@users.noreply.github.com>
Co-authored-by: Carlo <1778532+cdcme@users.noreply.github.com >
2026-04-01 11:21:11 -05:00
Rachael Shaw
999e17877e
Document default per-page for /os_versions API endpoint ( #42703 )
...
<!-- Add the related story/sub-task/bug number, like Resolves #123 , or
remove if NA -->
**Related issue:** Resolves #38000
2026-03-30 18:02:23 -05:00
Marko Lisica
6cd80d3c51
[Docs] VPP is not returned in fleetctl get config if set via UI or API ( #42071 )
...
Related to:
- #39641
2026-03-24 16:17:34 +01:00
Noah Talerman and Rachael Shaw
357d280c4a
Renaming: API reference ( #41942 )
...
For the following issue:
- #41419
- @noahtalerman: Also remove old bits about Fleet 4.0.0
---------
Co-authored-by: Rachael Shaw <r@rachael.wtf >
2026-03-19 14:15:00 -05:00
Noah Talerman
4d32731e55
API reference: Add missing bundle_identifier to "List software" ( #41826 )
2026-03-18 18:01:40 -05:00
3678d6a981
Revert: Change Apple OS update deadline from 7PM back to noon ( #38834 ) ( #41899 )
...
## Summary
- Reverts the changes introduced by issue
[#38834 ](https://github.com/fleetdm/fleet/issues/38834 ), which changed
the Apple (macOS, iOS, iPadOS) OS update enforcement deadline from 12:00
PM (Noon) to 7:00 PM local time.
- Reverts code from [PR
#38810 ](https://github.com/fleetdm/fleet/pull/38810 ) (backend, frontend,
tests) and [PR #39185 ](https://github.com/fleetdm/fleet/pull/39185 )
(documentation).
- Restores the original noon (12:00) deadline in the MDM declaration
payload, frontend tooltip, integration tests, REST API docs, and YAML
configuration docs.
## Changes
| File | Change |
|------|--------|
| `ee/server/service/mdm.go` | `TargetLocalDateTime` reverted from
`T19:00:00` to `T12:00:00` |
| `frontend/.../AppleOSTargetForm.tsx` | Deadline tooltip reverted from
"19:00 (7PM)" to "12:00 (Noon)" |
| `server/service/integration_enterprise_test.go` | Test assertion
reverted from `T19:00:00` to `T12:00:00` |
| `docs/Configuration/yaml-files.md` | 3 references reverted from "7PM"
to "noon" |
| `docs/REST API/rest-api.md` | 6 references reverted from "7PM" to
"noon" |
Built for
[ntalerman](https://fleetdm.slack.com/archives/D0AEA6U4SM9/p1773780763835429 )
by [Kilo for Slack](https://kilo.ai/features/slack-integration )
Co-authored-by: kiloconnect[bot] <240665456+kiloconnect[bot]@users.noreply.github.com>
Co-authored-by: George Karr <georgekarrv@users.noreply.github.com >
2026-03-18 14:07:20 -05:00
Juan Fernandez
067e5fb33f
Made Host Results endpoint URL consistent (33714) ( #41501 )
...
Resolves #33714
Added alias `GET /api/v1/fleet/scripts/batch/abc-def/host_results` for
`GET /api/v1/fleet/scripts/batch/abc-def/host-results` for consistency
sake.
2026-03-13 14:00:26 -04:00
+1
cc671f98c9
Preview of v4.82.0 doc changes ( #38894 )
...
This PR will remain in draft as a preview of upcoming documentation
changes for 4.82.0
---------
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: Magnus Jensen <magnus@fleetdm.com >
Co-authored-by: Victor Lyuboslavsky <2685025+getvictor@users.noreply.github.com >
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com >
Co-authored-by: Dante Catalfamo <43040593+dantecatalfamo@users.noreply.github.com >
Co-authored-by: melpike <79950145+melpike@users.noreply.github.com >
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com >
Co-authored-by: Nico <32375741+nulmete@users.noreply.github.com >
Co-authored-by: Scott Gress <scottmgress@gmail.com >
2026-03-12 18:19:53 -05:00
Noah Talerman and Rachael Shaw
75a61a8673
Document PUT /hosts/{id}/device_mapping side effect ( #41514 )
...
Until we fix this:
- https://github.com/fleetdm/fleet/issues/41239
---------
Co-authored-by: Rachael Shaw <r@rachael.wtf >
2026-03-11 18:39:16 -05:00
Magnus Jensen
302ee423dd
[API Docs]: mention ios, ipados and windows support for resend profile ( #41486 )
...
This support has been there for some time, it was just never updated.
2026-03-11 18:21:07 -05:00
Rachael Shaw
53ebf91be6
API design: #33522 Add executable hash/path to software ( #37212 )
...
Related to user story:
+ #33522
2026-03-06 18:28:30 -06:00
Steven Palmesano
c0e5adf32f
Fix broken human-device mapping links and spelling error ( #41069 )
2026-03-06 12:27:12 -06:00
Rachael Shaw and Marko Lisica
f10f9a955a
Cherry-pick: windows_entra_tenant_ids docs ( #41144 )
...
Cherry-pick of https://github.com/fleetdm/fleet/issues/39221 from
`docs-v4.82.0` into `main`
For user story:
- #39214
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com >
2026-03-06 11:39:07 -06:00
Juan Fernandez
c95283c490
Updated documentation for file carving REST endpoints ( #40698 )
...
Added notes explaining that network error will result in a failed carve
operation.
2026-02-27 14:43:36 -04:00
Katheryn Satterlee and Rachael Shaw
9e4a907f98
Fix typo in commands link and update API example ( #40206 )
...
Moved team_id in Batch update configuration profiles endpoint example
from request body to the request url.
---------
Co-authored-by: Rachael Shaw <r@rachael.wtf >
2026-02-23 13:42:32 -06:00
Noah Talerman
4c3a3e09a2
Move "Refetch host by token" to public API ( #40017 )
...
- Users/customers use it:
https://fleetdm.slack.com/archives/C050XE4CQNA/p1770941203226819?thread_ts=1770936601.691019&cid=C050XE4CQNA
- Rename this to "Fleet Desktop" token
2026-02-23 10:28:19 -06:00
+2
8822747d36
Preview of v4.81.0 doc changes ( #38211 )
...
This PR will remain in draft as a preview of upcoming documentation
changes for 4.81.0
---------
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com >
Co-authored-by: Ian Littman <iansltx@gmail.com >
Co-authored-by: kitzy <kitzy@fleetdm.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: Marko Lisica <83164494+marko-lisica@users.noreply.github.com >
Co-authored-by: Zach Wasserman <zach@fleetdm.com >
Co-authored-by: melpike <79950145+melpike@users.noreply.github.com >
Co-authored-by: Jordan Montgomery <elijah.jordan.montgomery@gmail.com >
Co-authored-by: Magnus Jensen <magnus@fleetdm.com >
Co-authored-by: Dante Catalfamo <43040593+dantecatalfamo@users.noreply.github.com >
2026-02-20 17:45:47 -06:00
Rachael Shaw
ee3ce0e624
API docs: "Device token" -> "Fleet Desktop token" ( #40193 )
...
To be consistent with naming in @noahtalerman's PR:
https://github.com/fleetdm/fleet/pull/40017
2026-02-20 13:22:55 -05:00
Noah Talerman and Rachael Shaw
495daf1006
API reference: How to filter hosts by platform ( #39418 )
...
Co-authored-by: Rachael Shaw <r@rachael.wtf >
2026-02-13 17:54:08 -06:00
Noah Talerman and Rachael Shaw
5430f8760f
API reference: Document what we know about "NotNow" ( #39412 )
...
- Document what we know about "NotNow"
- Context:
https://fleetdm.slack.com/archives/C050XE4CQNA/p1770244126667719?thread_ts=1769555555.606569&cid=C050XE4CQNA
---------
Co-authored-by: Rachael Shaw <r@rachael.wtf >
2026-02-13 17:45:41 -06:00
Noah Talerman
59cff14a91
API reference: List hosts includes last_opened_at ( #39573 )
...
- When `populate_software=true`
- This came up in GitHub here:
https://github.com/fleetdm/fleet/issues/38645#issuecomment-3863021910
2026-02-10 17:07:30 -06:00
Marko Lisica
50d6dd2652
Remove 'fleet_maintained' field from policy and software endpoints ( #39605 )
...
This field doesn't exist. Probably accidentally merged.
2026-02-10 17:07:12 -06:00
Rachael Shaw
d401334d4c
Clearer callout clarifying hostname is not the same as display name ( #39274 )
2026-02-03 17:03:29 -06:00
dafc8f6752
Preview of v4.80.0 doc changes ( #37193 )
...
This PR will remain in draft as a preview of upcoming documentation
changes for 4.80.0
---------
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com >
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com >
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com >
Co-authored-by: Magnus Jensen <magnus@fleetdm.com >
Co-authored-by: Jordan Montgomery <elijah.jordan.montgomery@gmail.com >
Co-authored-by: Scott Gress <scottmgress@gmail.com >
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com >
Co-authored-by: Nico <32375741+nulmete@users.noreply.github.com >
Co-authored-by: Luke Heath <luke@fleetdm.com >
2026-02-02 17:41:37 -06:00
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
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
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 and Marko Lisica
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
+5
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
Rachael Shaw