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
Rachael Shaw
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
Marko Lisica
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
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
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
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
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
08497bd5fe
Update rest-api.md ( #16508 )
...
- Update titles for enroll secret endpoints
- Use “list” for many and “get” for single
- No articles (“a” or “the”) in titles to make them shorter
2024-01-31 18:54:27 -05:00
Noah Talerman
1022282c15
Docs: update links ( #16434 )
...
- Update links for deprecated API endpoints so that they link to the
before they were deprecated
2024-01-30 10:14:48 -05:00
Marko Lisica
fb395f5ef1
API design: software titles ( #14831 )
...
API changes for the following story:
- #14674
- Both `GET /software` and [`GET
/software/versions`](https://github.com/fleetdm/fleet/pull/14831/files#diff-7246bc304b15c8865ed8eaa205e9c244d0a0314e4bae60cf553dc06147c38b64R7035 )
will work the same. We're just documenting `GET /software/versions`
- Both `GET /software/{id}` and `GET /software/versions/{id}` will work
the same. We're just documenting `GET /software/versions/{id}`
- `count` added in both `GET /software/versions` and `GET
/software/titles`. `GET / software/count` still available (but removed
from docs).
---------
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Sarah Gillespie <73313222+gillespi314@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-01-29 17:19:26 -06:00
Victor Lyuboslavsky
edee09e22a
Added parameter to PATCH /fleet/teams/:id endpoint ( #16254 )
...
API doc update for #15609
Added parameter to PATCH /fleet/teams/:id endpoint
2024-01-24 13:06:15 -06:00
Marko Lisica
99163d5dfc
MDM Custom settings (profiles) - API changes ( #14230 )
...
API changes for the Windows configuration profiles story:
- #13281
It's **ready for review**, but marked as a draft because of KPI (PR open
time)
- DONE: Remove activity types changes before merging (those will be
automatically generated)
#### `profile_id` and `profile_uuid` changes specified in following
ticket:
- #15274
---------
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-01-24 11:13:56 -06:00
Victor Lyuboslavsky
ac068f85c8
Failing policies are now listed first. ( #16103 )
...
API doc changes for #10379 -- failing policies are listed first.
2024-01-16 10:23:31 -06:00
Marko Lisica
8aaa4600ed
Docs: Configure script execution timeout ( #15483 )
...
Docs changes for:
- #15196
2024-01-12 17:29:43 -05:00
Rachael Shaw
bc075b1eea
#15058 API design: Add gigs total disk space to host endpoints ( #15442 )
...
Rest API changes for https://github.com/fleetdm/fleet/issues/15058
2024-01-11 14:35:56 -05:00
Rachael Shaw
7c84588689
#14800 API design: POST request for "Run live query" endpoint ( #15508 )
...
"Run live query" API updates based on @jrzmurray's PR
https://github.com/fleetdm/fleet/pull/13002 , to resolve issue
https://github.com/fleetdm/fleet/issues/14800 .
2024-01-11 14:28:48 -05:00
Noah Talerman
7a0e2089c4
API design: Get email w/o relying on end user ( #15445 )
...
- API changes for Get email w/o relying on end user: #15057
2024-01-10 17:29:51 -05:00
Noah Talerman
5f38355169
Merge fleetd doc page to enroll hosts page ( #15907 )
...
- Move relevant content from "Fleetd" doc page to "Enroll hosts" page
- Remove "Fleetd" docs page
2024-01-10 14:35:18 -05:00
Marko Lisica
89ff5541d3
API design: Lookup hosts based on IdP email ( #15305 )
...
API changes for the following story:
- #13034
2024-01-10 09:23:56 -05:00
Tim Lee
2f937ce9a2
Docs: Host Details Pack Stats API ( #15672 )
2024-01-04 11:16:47 -07:00
Noah Talerman
3326dd4186
API design: Target hosts by serial number ( #15344 )
...
- API changes for #14748
- Document `hardware_serial` name to be consistent w/ `hardware_serial`
parameter in hosts endpoints
2024-01-03 17:59:23 -05:00
Victor Lyuboslavsky
8c9feedc98
API change: add host_count_updated_at to policies ( #15765 )
...
API Change for #15323
2024-01-02 13:41:54 -06:00
Rachael Shaw
c40bd9f3c3
#12889 API design: Add software to "List hosts" response ( #15019 )
...
Proposed solution for https://github.com/fleetdm/fleet/issues/12889 .
2023-12-15 15:59:45 -06:00
Rachael Shaw
197470a3ce
#14920 API design: Add device health endpoint ( #15038 )
...
Proposed first version of the device health API endpoint for #14920
2023-12-15 15:57:41 -06:00
Victor Lyuboslavsky
24c9f5a4b6
Added query param to fleet/queries. ( #15673 )
...
Added query param to fleet/queries.
API change for #15630
2023-12-15 12:58:06 -06:00
Rachael Shaw
5e3f501c87
#14415 API design: Per-host query report endpoint ( #14805 )
...
Adds new API endpoint to enable displaying query reports per-host
(#14415 ).
---------
Co-authored-by: Tim Lee <timlee@fleetdm.com>
2023-12-15 12:27:20 -06:00
Rachael Shaw
832f7fd8b6
API changes for confidential/#2118 ( #15092 )
...
API changes for https://github.com/fleetdm/confidential/issues/2118
---------
Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
2023-12-08 17:12:24 -06:00
Rachael Shaw
3d14cc841d
REST API docs: Consistent URL parameter formatting ( #15535 )
...
Makes parameter formatting in documented REST API paths consistent.
Previously, we were using a mix of `/foo/:parameter/bar` and
`/foo/{parameter}/bar`. This updates all URLs to use `:` instead of
`{…}`.
Also, opportunistically fixed some other inconsistent formatting I
noticed in a couple places.
2023-12-08 16:22:20 -06:00
Roberto Dip
1a526aa19f
update documentation with expected response ( #15527 )
...
for #13251
2023-12-08 18:56:58 -03:00
Noah Talerman
845ef393bb
Update scripts docs ( #15416 )
...
- Simplify usage instructions to make it more like a reference
- Move "Run script asynchronously" to contributor docs so that user
facing API docs have one best practice API endpoint for scripts. Call
synchronous endpoint "Run script"
2023-12-06 12:40:42 -05:00
Martin Angers
88612cdf8c
Add back Windows OS Updates documentation changes ( #15363 )
2023-12-04 09:50:06 -05:00
Martin Angers
6fd06d6486
Add back Windows Profiles documentation changes ( #15358 )
2023-12-04 08:41:37 -05:00
Roberto Dip
9c7b740b03
disable windows profiles feature in the back-end ( #15278 )
...
per discussion in slack, reverting relevant user-facing changes for
#13281
2023-11-27 16:08:52 -03:00
