All Applicable Patches
This API is currently supported only in On-premises.
This API provides a comprehensive list of all the patches that are applicable to systems.
- Functionality
- Fetchs the list of patches that are applicable.
- HTTP Method
- GET
- API URI
- /dcapi/threats/patches
- Scope
- DesktopCentralCloud.PatchMgmt.READ
- Filters
- patchname={String}:
Filters patches that contain the provided patch name.
patch_description={String}:
Filters patches that contain the provided patch description.
patchid={Numeric}:
Filters patches based on the patch ID provided.
patch_uninstall={String}:
Filters patches based on the patch uninstallation support (as specified by the vendor).
bulletinid={String}:
Filters patches based on the Bulletin ID provided.
severity={String}:
Filters patches based on the severity provided.
updated_time={Numeric}:
Filters patches based on the approved time.
kb_number={String}:
Filters patches based on the provided KB number.
vendor_name={String}:
Filters patches based on the vendor name provided.
update_type={String}:
Filters patches based on the type of patch provided. (Applicable inputs: Security Updates, Non-Security Updates, Third-Party Updates, Definition Update, Service Packs, Feature Packs, Rollups, Tools, Driver, Optional Updates, Preview Rollups and BIOS)
patch_released_time={Numeric}:
Filters patches based on the provided patch release date.
patch_supported_time={Numeric}:
Filters patches based on the provided patch support date.
patch_size={Numeric}:
Filters patches based on the provided size.
approveduser_first_name={String}:
Filters approved patches based on the specified username that approved the patches.
reboot_required={String}:
Filters patches based on the post-deployment reboot option configured. (Applicable inputs: required, not required, autoreboot, may require)
platform_name={String}:
Filters the applicable patches based on the platform provided.
download_status={String}:
Filters patches based on the download status provided.
patch_status={String}:
Filters patches based on the provided patch status.
cveids={String}:
Filters patches based on the CVE ID provided.
- Display preferences
- page={Numeric}:
Displays the content of the provided page number.
pageLimit={Numeric}:
Displays the provided number of patch details per page.
Response Data
{ "metadata": { "pageLimit": 30, "totalRecords": "2", "totalPages": 1, "links": { "next": null, "prev": null }, "page": 1 }, "response_code": 200, "message_type": "patches", "message_response": { "patches": [ { "severity": "Important", "patchname": "vcredist_x86_sp1.exe", "updated_time": "1704363395117", "update_type": "Security Updates", "patch_description": "Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update", "kb_number": "2565063", "vendor_name": "Microsoft", "installed_system_count": 1, "supercededby": "NA", "patch_released_time": "1307989800000", "patch_supported_time": "1307989800000", "patch_size": "8993744", "patchid": "12621", "patch_uninstall": "not supported", "bulletinid": "MS11-025", "approveduser_first_name": "DC-SYSTEM-USER", "reboot_required": "may require", "platform_name": "Windows", "download_status": "--", "missing_system_count": 0, "failed_system_count": 0, "patch_status": "approved" }, { "severity": "Important", "patchname": "vcredist_x64_sp1.exe", "updated_time": "1704363395117", "update_type": "Security Updates", "patch_description": "Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update", "kb_number": "2565063", "vendor_name": "Microsoft", "installed_system_count": 1, "supercededby": "NA", "patch_released_time": "1307989800000", "patch_supported_time": "1307989800000", "patch_size": "10274136", "patchid": "12622", "patch_uninstall": "not supported", "bulletinid": "MS11-025", "approveduser_first_name": "DC-SYSTEM-USER", "reboot_required": "may require", "platform_name": "Windows", "download_status": "--", "missing_system_count": 0, "failed_system_count": 0, "patch_status": "approved" } ] }, "status": "success" }