diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index 997fbe1587..04c50e2564 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -3170,8 +3170,8 @@ the `software` table. | software_title_id | integer | query | The ID of the software title to filter hosts by. | | software_status | string | query | The status of the software install to filter hosts by. One of: `pending_install`, `failed_install`, `installed`, `pending_uninstall`, `failed_uninstall`, `pending`, or `failed`. Mutually exclusive with `software_version_id`, and must be supplied if `software_title_id` is set. | | os_version_id | integer | query | The ID of the operating system version to filter hosts by. | -| 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` | +| os_name | string | query | The name of the operating system to filter hosts by. `os_version` must also be specified with `os_name`. See note below for filtering Windows hosts. | +| os_version | string | query | The version of the operating system to filter hosts by. `os_name` must also be specified with `os_version`. See note below for filtering Windows hosts. | | vulnerability | string | query | The cve to filter hosts by (including "cve-" prefix, case-insensitive). | | device_mapping | boolean | query | Indicates whether `device_mapping` should be included for each host. | | mdm_id | integer | query | The ID of the _mobile device management_ (MDM) solution to filter hosts by (that is, filter hosts that use a specific MDM provider and URL). | @@ -3218,6 +3218,8 @@ If `include_device_status` is set to `true`, `device_status` and `pending_action To filter hosts by platform (macOS, Windows, Linux), use the ["List label's hosts" API endpoint](https://fleetdm.com/docs/rest-api/rest-api#list-labels-hosts). Find the label ID by filtering in the **Hosts** page of the Fleet UI and copying the ID from the URL (for example: `7` for `/hosts/manage/labels/7`). +To filter Windows hosts using `os_name` and `os_version`, set `os_name` to the full operating system name without the build number, and set `os_version` to the build number. For example, if the **Operating system** field in host details shows `Windows 11 Home Single Language 23H2 10.0.22631.5335`, query with `os_name=Microsoft Windows 11 Home Single Language 23H2` and `os_version=10.0.22631.5335`. For macOS and Linux hosts, `os_name` is the OS name (for example, `macOS` or `Ubuntu`) and `os_version` is the version number (for example, `15.2` or `20.04.3 LTS`). + #### Example `GET /api/v1/fleet/hosts?page=0&per_page=100&order_key=hostname&query=2ce&populate_software=true&populate_policies=true&populate_users=true&populate_labels=true&include_device_status=true` @@ -4667,7 +4669,7 @@ Request (`filters` is specified and empty, to delete all hosts): Updates the email for the data source in the human-device mapping. This source can only have one email. -> If you're using the `$FLEET_VAR_HOST_END_USER_IDP_USERNAME` variable in Apple (macOS, iOS, iPadOS) and Windows configuration profiles, overriding the `idp` data source resends the configuraiton profile even if the value is unchanged. This causes performance issues. In the future, Fleet will only resend profiles if the value changes ([coming soon](https://github.com/fleetdm/fleet/issues/41239)). In the interim, please only update the `idp` data source when the value changes. +> If you're using the `$FLEET_VAR_HOST_END_USER_IDP_USERNAME` variable in Apple (macOS, iOS, iPadOS) and Windows configuration profiles, overriding the `idp` data source resends the configuration profile even if the value is unchanged. This causes performance issues. In the future, Fleet will only resend profiles if the value changes ([coming soon](https://github.com/fleetdm/fleet/issues/41239)). In the interim, please only update the `idp` data source when the value changes. #### Parameters