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 Talerman and Rachael 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 Shaw and George 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 Shaw and Marko 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 Shaw and Marko 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 Shaw and Noah 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 Shaw and Eric
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 Lisica and Rachael 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 Shaw and Victor 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 Bilstad and Rachael 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 Shaw and Noah 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
Marko Lisica
4585a6e2c2
API design: Pre-fill and lock local account creation screen during out-of-the-box macOS setup ( #17118 )
...
API design for:
- #9147
2024-04-04 14:38:42 -04:00
Rachael Shaw
1d80aa7668
When flagging a parameter as premium-only, always include a period. ( #18038 )
...
For better readability: add periods as separation between the Fleet
Premium message and parameter descriptions.
✅ _Available in Fleet Premium_. Description text.
❌ _Available in Fleet Premium_ Description text.
2024-04-03 11:48:22 -05:00
87fe581b93
Scripts API: documented missing parameter and improved copy ( #17881 )
...
- Updated `GET /api/v1/fleet/scripts`: documented `team_id` parameter
that was missing
- Replaced "Upload" with "Add" since that's the language we want to use
across the product and docs.
- Removed articles from headings
---------
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com >
Co-authored-by: Rachael Shaw <r@rachael.wtf >
2024-04-01 16:53:00 -05:00
Noah Talerman
4271ca7fd6
Update rest-api.md ( #17794 )
...
- Clarify that hostnames are fully qualified domain names (FQDNs). FQDN
= hostname + domain.
For the following issue: #16895
2024-03-26 11:16:28 -05:00
Noah Talerman
a0e3407f21
Update rest-api.md ( #17801 )
...
- Fix anchor link
2024-03-25 09:41:12 -04:00
Marko Lisica and Rachael Shaw
a71e4c7d92
Typo: "removing" /past from host's activities API ( #16871 )
...
Typo: "removing" /past from host's activities API
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
<!-- Note that API documentation changes are now addressed by the
product design team. -->
- [ ] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files )
for more information.
- [ ] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [ ] Added/updated tests
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For 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.
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
---------
Co-authored-by: Rachael Shaw <r@rachael.wtf >
2024-03-22 11:42:11 +01:00
Noah Talerman
1bb81c9e10
Update rest-api.md ( #17686 )
...
- Remove note about fleetd
- Update note about MDM being turned on
2024-03-21 15:44:23 -04:00
Noah Talerman
4a0c62613f
API design: See macOS hosts that failed DEP profile assignment ( #15461 ) ( #16166 )
...
API changes for the "See macOS hosts that failed DEP profile assignment"
(#15461 ) story
2024-03-21 13:33:35 -05:00
Marko Lisica and Rachael Shaw
14786afe20
API design: Increase character limit for saved scripts ( #16699 )
...
API design for:
#16668
---------
Co-authored-by: Rachael Shaw <r@rachael.wtf >
2024-03-21 13:30:48 -05:00
Rachael Shaw
5349403374
API design: Wipe host ( #17107 )
...
REST API updates for remote wipe
([#9951 ](https://github.com/fleetdm/fleet/issues/9951 )).
2024-03-14 14:30:16 -04:00
bc034b6bb2
#15919 API design: Vulnerabilities page ( #16443 )
...
REST API changes for #15919
---------
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com >
Co-authored-by: Tim Lee <timlee@fleetdm.com >
2024-03-14 13:27:07 -05:00
Rachael Shaw
ee7dbaa5a0
#1642 API design: Populate policy data in GET /hosts API ( #16582 )
...
- Adds a `populate_policies` parameter to the "List hosts" endpoint
2024-03-14 14:07:03 -04:00
Rachael Shaw
6f7fd8f881
Docs: Fix some links in the hosts API section ( #17449 )
...
Noticed a few links in the hosts section of the REST API docs that were
out-of-date or missing.
2024-03-06 16:34:29 -06:00
RachelElysia
316321e889
[released bug] Fleet Full stack: Allow teams filter when transferring hosts by filters ( #17241 )
2024-03-04 15:48:19 -05:00
Rachael Shaw
dd2d6eb4d0
Update "Team member" wording in docs to reference users instead. ( #17116 )
...
+ Changed a bunch of instances of "member" to "user" to match the
updated UI (https://github.com/fleetdm/fleet/issues/15893 )
+ Cut some step-by-step instructions for using the team UI from the
"Segment hosts" docs
2024-02-29 16:07:59 -05:00
Rachael Shaw
4751e6652a
API docs: Add missing Fleet Premium clarification ( #17255 )
...
+ Add some missing "_Available in Fleet Premium_." flags to `team_id`
parameter descriptions for API endpoints available in Fleet Free.
+ Remove one duplicate instance of `team_id`
2024-02-28 15:15:10 -06:00
Rachael Shaw
d50ee081f2
API docs: Remove mdm.device_status and mdm.pending_action from list hosts response ( #17222 )
...
The "List hosts" endpoint doesn't actually include this information.
2024-02-27 16:05:10 -06:00
Noah Talerman
c0e27ea115
API docs: Add note to Get host by identifier ( #17097 )
...
- `hostname` isn't always unique
2024-02-27 09:06:15 -05:00
Rachael Shaw
094392798d
Fix "Team policies" API docs heading ( #17191 )
...
Change from h3 to h2 so it's visible in the side navigation.
2024-02-26 16:27:24 -06:00
Rachael Shaw
1146141f2d
Fix formatting in a few places in the REST API docs ( #17145 )
...
+ Fixed some indentation
+ Added some missing commas & quotation marks
2024-02-23 17:26:39 -06:00
Rachael Shaw
6a975b479e
Small grammatical fix ( #17131 )
...
Missing "the" in a note in the REST API docs and tweaked wording a
little bit.
2024-02-23 13:00:23 -06:00
489b45368e
API design: enable profiles based on labels ( #15117 )
...
API changes for the following story:
- #14715
---------
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com >
Co-authored-by: Rachael Shaw <r@rachael.wtf >
Co-authored-by: Roberto Dip <me@roperzh.com >
2024-02-23 12:54:18 -06:00
Marko Lisica and Noah Talerman
47e584da4f
API design: Improve troubleshooting workflow for Windows custom MDM commands and profiles ( #16408 )
...
API design for:
- #15769
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com >
2024-02-22 13:17:37 -06:00
Rachael Shaw and George Karr
07d8829d78
API design: Lock & unlock hosts ( #16157 )
...
REST API updates for remote lock
([#9949 ](https://github.com/fleetdm/fleet/issues/9949 )).
---------
Co-authored-by: George Karr <georgekarrv@users.noreply.github.com >
2024-02-22 13:06:47 -06:00
Rachael Shaw and Tim Lee
f3cbea355a
#4345 API design: macOS and Windows OS vulnerabilities ( #15492 )
...
Updates "Get host OS versions" endpoint to include vulnerabilities
(https://github.com/fleetdm/fleet/issues/4345 )
---------
Co-authored-by: Tim Lee <timlee@fleetdm.com >
2024-02-16 18:40:33 -06:00
Rachael Shaw
06b0c4fee4
API design: Live query endpoint for ad-hoc queries ( #16792 )
...
API docs for https://github.com/fleetdm/fleet/issues/16805
2024-02-16 12:21:15 -06:00
Rachael Shaw
3c06a0e6bf
Fix "Get manual enrollment profile" formatting ( #16720 )
...
Should be an h3 and have a link @ the top of the section like other API
endpoints.
2024-02-09 15:16:52 -06:00
Rachael Shaw
102d80e463
Document how to list all hosts on "No team" ( #16635 )
...
Example of documentation work for
https://github.com/fleetdm/fleet/issues/16350
2024-02-08 16:27:38 -05:00
Sabrina Coy
33563fba6e
Update rest-api.md ( #16630 )
...
Corrected status code from `2000` to `200`
2024-02-06 17:17:26 -05:00
Noah Talerman
7fdda53dca
API design: Upcoming activities: Run scripts on online/offline hosts ( #15931 )
...
API changes for the "Upcoming activities: Run scripts on online/offline
hosts" (#15529 ) story
Changes:
- Script endpoints are available in Fleet Free and Fleet Premium
- Update `POST /scripts/run` to add a script to the bottom of the
upcoming activities
- Update `POST /scripts/run/sync`
- Add `GET /hosts/:id/activities` to show past activity feed
- Add `GET /hosts/:id/activities/upcoming` to show upcoming activity
feed
- Move docs for `GET /hosts/:id/scripts` to a new "Get host's scripts
section" under "Hosts"
2024-02-05 18:37:35 -05:00
Noah Talerman
c0f6e1f1cb
API design: Add API endpoint to get manual enrollment profile ( #16252 ) ( #16255 )
...
API changes for the "Add API endpoint to get manual enrollment profile"
story: #16252
2024-02-05 18:35:44 -05:00
Victor Lyuboslavsky and Rachael Shaw
78911e9595
Updated docs for PATCH teams/:id/users ( #16336 )
...
Updated docs for PATCH teams/:id/users
#16275
---------
Co-authored-by: Rachael Shaw <r@rachael.wtf >
2024-02-04 14:52:45 -06:00
Marko Lisica
cb593d4818
Fix broken link in MDM section ( #16507 )
2024-02-01 17:11:11 -06:00
Noah Talerman