Discharge7443/fleet
1
0
Fork 0
Code Issues Pull Requests Actions 27 Packages Projects Releases Wiki Activity

API design: #33758 (OS vulnerabilities bug) (#33533)

Browse Source 
> This PR to be left in draft until bug is brought into a sprint, at
which point we'll close and re-open to the correct release branch.

Changes for the following bug:
+ https://github.com/fleetdm/fleet/issues/33758

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
This commit is contained in:
Rachael Shaw
2025-11-14 16:58:00 -05:00
committed by GitHub
co-authored by Noah Talerman
parent 28f58ed465
commit a074498668
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/REST API/rest-api.md
+3
View File
@@ -9681,6 +9681,7 @@ Returns a list of all operating systems.
| platform | string | query | Filters the hosts to the specified platform |
| os_name | string | query | The name of the operating system to filter hosts by. `os_version` must also be specified with `os_name` |
| os_version | string | query | The version of the operating system to filter hosts by. `os_name` must also be specified with `os_version` |
| max_vulnerabilities | integer | query | Limits the number of `vulnerabilities` returned per OS version. (If omitted, returns all vulnerabilities.) |
| page | integer | query | Page number of the results to fetch. |
| per_page | integer | query | Results per page. |
| order_key | string | query | What to order results by. Allowed fields are: `hosts_count`. Default is `hosts_count` (descending). |
@@ -9704,6 +9705,7 @@ Returns a list of all operating systems.
"version": "10.0.22621.1234",
"platform": "windows",
"generated_cpes": [],
"vulnerabilities_count": 1,
"vulnerabilities": [
{
"cve": "CVE-2022-30190",
@@ -10003,6 +10005,7 @@ Retrieves information about the specified operating system (OS) version.
| ---- | ---- | -- | ----------- |
| id | integer | path | **Required.** The OS version's ID. |
| team_id | integer | query | _Available in Fleet Premium_. Filters response data to the specified team. Use `0` to filter by hosts assigned to "No team". |
| max_vulnerabilities | integer | query | Limits the number of `vulnerabilities` returned. (If omitted, returns all vulnerabilities.) For Linux OS's, doesn't limit the number of vulnerabilities returned in the `kernels` array. |
##### Default response