Commit Graph
155 Commits
Author SHA1 Message Date
Marko Lisica 5820d028e0 API design: Improve host identifiers in the docs, CLI and API (#19752)
API design for: #19127
2024-08-01 11:11:07 -04:00
Noah Talerman 935f489397 Guide and API reference: Show iOS & iPadOS as supported platforms in the UI (#20746)
Guide and API reference changes for the following story:
- #19319
2024-07-26 16:04:35 -04:00
Marko LisicaandNoah Talerman 36c1b918d3 API design: Scope configuration profiles to hosts by excluding any label (#20614)
API design for:  #17315

Old PR: #18844

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-07-26 12:32:02 +02:00
Noah Talerman b77f9070be API design: Add host's next scheduled maintenance window to "Get host" (#20745)
API changes for the following story:
- #18554
2024-07-25 18:28:24 -04:00
Noah Talerman 7195126ce6 API reference: Wipe iOS/iPadOS (#20766) 2024-07-25 15:26:13 -07:00
Marko Lisica 7ff93583e8 API changes: Increase timeout limit for scripts (#20650)
API changes for:  #16645
2024-07-25 18:25:48 -04:00
Noah Talerman 0a37118660 API design: Filters for fleetctl get mdm-commands (#20623)
API design for:
-  #19143
2024-07-25 18:13:49 -04:00
Marko Lisica e385f2c75a Mark software API endpoints as experimental (#20658)
- Mark new API endpoints or API endpoints that were changed as part of
Fleet's first app management feature (#14921) as experimental.
- Call out what is experimental exactly (the endpoint or new keys/values) and
point to changes
2024-07-24 18:35:57 -04:00
Rachael Shaw e4044c5d63 Documentation for query_report_cap config (#20414)
- Add documentation for the `query_report_cap` config option. For #19600
2024-07-15 14:10:34 -04:00
James Kane 4e0c447daa Add "exclude software" parameter to get host by identifier (#20133)
For #19540

Just added the same "exclude_software" functionality that exists in "get
hosts" to the "get host by identifier" function.

- [ ] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Manual QA for all new/changed functionality
2024-07-11 15:48:15 -05:00
Tim Lee 812140a760 Add createdAt to Vulnerability responses (#20019) 2024-07-09 11:09:16 -06:00
055145b7d3 API design: Software self-service (#20223)
API design for:
- #17587

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Martin Angers <martin.n.angers@gmail.com>
2024-07-09 18:23:44 +02:00
Marko Lisica 606fa14ed4 Fix broken link (#20151)
Link isn't working (org_setings)
2024-07-03 16:29:10 -05:00
Marko Lisica 9299f303e7 List software API: Fix the typo (#20155)
Fix the typo `GET /software/titles` > `available_for_install` param.
2024-07-02 13:59:20 -05:00
Noah Talerman 0076148a79 Docs: GitOps reference (#19740)
Docs for Fleet's best practice GitOps: #13643 (also #17043)
2024-07-02 11:11:43 -04:00
Rachael Shaw dc9a94abfc REST API docs: fix a few "Modify configuration" parameter descriptions (#20137)
Follow up from https://github.com/fleetdm/fleet/pull/20109: there were a
few descriptions that just said "body" because of some table rows with
an extra column I missed when merging in recent updates.
2024-07-01 17:05:29 -05:00
Rachael Shaw 1c3448eb42 Update how we document the objects in the "Modify configuration" parameters (#20109)
Since the "Modify config" parameters are mostly a bunch of different
objects, it's a bit unwieldy to document in one table. Trying out a new
format to see if it feels like the right way to document nested objects
in API parameters.
2024-07-01 16:51:56 -05:00
Noah Talerman 93eb61057c API design: Find hosts with the most issues (#20122)
API changes for the "Find hosts with the most issues" story
- #18115
2024-07-01 16:06:21 -04:00
Noah TalermanandVictor Lyuboslavsky 5775f47a28 API design: Get unlock PIN immediately after locking macOS host (#20123)
API changes for the "Get unlock PIN immediately after locking macOS
host" story (https://github.com/fleetdm/fleet/issues/19545)

---------

Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
2024-07-01 13:45:01 -05:00
RachelElysia f26acee2e1 Fleet docs: Update config > sso settings documentation (#20092) 2024-06-28 13:42:14 -04:00
RachelElysia 077915eb38 Fleet docs: Update config > features documentation (#20087) 2024-06-28 13:32:57 -04:00
Eric e10b6c72c7 Docs: Update broken link in REST API documentation (#20060)
Closes: https://github.com/fleetdm/fleet/issues/20041

Changes:
- Updated a link to a moved section in the scripts section of the REST
API documentation
2024-06-27 18:31:45 -05:00
Rachael Shaw a59cfc00be 16961 API changes (#20049)
API changes for #16961 

See https://github.com/fleetdm/fleet/pull/17609
2024-06-27 09:52:48 -05:00
Victor Lyuboslavsky e3510cdcf6 Add exclude_software query param to hosts endpoint. (#19617)
API docs change for #19348
2024-06-20 08:06:46 -05:00
Noah Talerman a327aacdc4 REST API docs: Fix typo (#19729) 2024-06-13 13:43:17 -04:00
Marko LisicaandRachael Shaw f71819a673 API design: Webhooks for global activity feed (#19725)
API design for: #14722

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-06-13 17:31:56 +02:00
Noah Talerman 80677d1dd0 REST API docs: Add policy (#19699)
- Fix typo in descriptions
- Remove legacy/deprecated way of adding a policy
2024-06-12 18:30:28 -04:00
Noah Talerman bac033e0d6 REST API docs: manual enrollment profile (#19593)
- Clarify that the manual enrollment profile is unsigned
2024-06-12 18:29:19 -04:00
Rachael ShawandNoah Talerman 5b4488c6b7 API docs: Update macos_settings and windows_settings format (#19476)
Noticed several places where the structure of
`mdm.macos_settings.custom_settings` and
`mdm.windows_settings.custom_settings` didn't match the example response
for "Get configuration" (which I think is the most up-to-date).

(Will follow up and update the parameter descriptions for
`mdm.macos_settings.custom_settings`/`mdm.windows_settings.custom_settings`
to clarify they're objects with `path` and `labels` once
https://github.com/fleetdm/fleet/pull/19424 is merged.)

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-06-12 15:45:26 -05:00
Rachael Shaw 77228ff433 Fleet configuration API docs: Document server_settings.enable_analytics (#19384)
`server_settings.enable_analytics` was only documented in the "Get
configuration" endpoint and nowhere else. Added to "Modify
configuration" params and example response.
2024-05-30 14:24:19 -05:00
Rachael Shaw 61f366fe3a #18187 API docs: AI-generated calendar description for policy remediation (#19383)
Documents the new Fleet configuration setting:
`server_settings.ai_features_disabled`

For #18187
2024-05-30 14:09:25 -05:00
Rachael Shaw 8daa61d963 #15605 API docs: Merge inherited & team queries/policies (#19375)
New PR to avoid affecting PR open time KPI. See previous PR discussion
here: https://github.com/fleetdm/fleet/pull/17227
2024-05-30 12:16:08 -05:00
Rachael Shaw 9afe9f3e0c #16989 API design: Settings to automatically delete activity (#19374)
New PR to avoid affecting PR open time KPI. See draft PR for previous
discussion: https://github.com/fleetdm/fleet/pull/17809
2024-05-30 12:07:38 -05:00
Noah Talerman 23e80f2ce4 API design: Deploy security agents to macOS, Windows, and Linux hosts (#19245)
API changes for:
- #14921
2024-05-23 17:07:07 -04:00
Noah TalermanandRachael Shaw 7bb215a0b1 Cleanup docs: Pre-fill and lock local account creation screen during out-of-the-box macOS setup (#19225)
Docs changes for "Pre-fill and lock local account creation screen during
out-of-the-box macOS setup" story (#9147)

See comment here for more context:
https://github.com/fleetdm/fleet/issues/9147#issuecomment-2127391460

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-05-23 10:33:09 -05:00
Noah Talerman 54cca7b28a Docs: Fix broken links & add redirects (#19066) 2024-05-17 11:24:33 -05:00
Rachael ShawandGeorge Karr 7ca3bda4a4 Recategorize & reorganize /mdm/ REST API endpoints (#18886)
Original PR for API design: https://github.com/fleetdm/fleet/pull/16728

---------

Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
2024-05-10 16:57:06 -05:00
db070837c8 API design: Create API endpoint to turn disk encryption for teams crossplatform (#18885)
Original PR: https://github.com/fleetdm/fleet/pull/16129

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-05-09 13:57:38 -05:00
Rachael ShawandMarko Lisica 6fa8763714 API design: Add declaration (DDM) profiles for macOS (#18718)
Fresh PR to avoid product design PRs messing with the PR open time KPI
(original here: https://github.com/fleetdm/fleet/pull/17369)

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2024-05-02 17:33:06 -05:00
e213ebde45 API design: Resend configuration profile (#18717)
Fresh PR to avoid product design PRs messing with the PR open time KPI
(previously https://github.com/fleetdm/fleet/pull/17711)

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
2024-05-02 17:08:22 -05:00
Rachael ShawandMarko Lisica 080d466121 API design: Add manual labels via UI and API (#18716)
Fresh PR to avoid product design PRs messing with the PR open time KPI
(previously https://github.com/fleetdm/fleet/pull/17670)

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2024-05-02 16:59:03 -05:00
Rachael ShawandNoah Talerman 74eb6c4f01 API design: Add critical policy and resolution data to device health API (#18715)
Fresh PR to avoid product design PRs messing with the PR open time KPI
(original: https://github.com/fleetdm/fleet/pull/16982)

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-05-02 16:28:34 -05:00
Rachael ShawandEric 895d4bc2f7 Use "Fleet's agent (fleetd)" naming in the docs (#18138)
For #16512

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
2024-04-29 11:12:03 -05:00
Marko LisicaandRachael Shaw a0a8579b56 API design: API endpoint for updating a host's manual labels (#16979)
API design for: 
- #16767

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-04-25 15:53:01 -05:00
Rachael ShawandVictor Lyuboslavsky 1657b38eba #17361 API changes: Add fleetd version to host details (#17814)
For #17361.

---------

Co-authored-by: Victor Lyuboslavsky <victor@fleetdm.com>
2024-04-25 13:26:28 -05:00
Rachael Shaw de26973953 #17148 API changes: See if scripts are enabled for a host (#17813)
For #17148.
2024-04-25 13:20:01 -05:00
Grant BilstadandRachael Shaw 414c27d53b Add link to file carve contributor docs (#18309)
File carves were moved to their own section in contributor docs
https://github.com/fleetdm/fleet/pull/16877
Fixed link on API page

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-04-25 10:19:33 -06:00
Victor Lyuboslavsky 1dc1e23b65 Removed current_instance_checks from docs. (#18186)
#16661 

Removed current_instance_checks from docs.
2024-04-15 10:25:04 -05:00
Rachael ShawandNoah Talerman 29b482fffa #17230 API design: Fleet in your calendar (#17552)
REST API updates for #17230.

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-04-12 18:01:52 -05:00
Rachael Shaw 57a28ed18d #14916 Configuration change: Host status webhook per-team (#15612)
Adds `webhook_settings.host_status_webhook` options to team config for
#14916.

Also updated conceptual docs that reference this config (and cut down
some content to make room).
2024-04-10 15:28:17 -05:00