System and Patch Details
This API is currently supported only in On-premises.
This API provides the list of systems and their patch details.
- Functionality
- Fetchs the list of systems and their patch details.
- HTTP Method
- GET
- API URI
- /dcapi/threats/systemreport/patches
- Scope
- DesktopCentralCloud.PatchMgmt.READ
- Filters
- resource_id={Numeric}:
Filters systems based on the resource ID provided. Refer to this page to fetch resource id.
patchname={String}:
Filters systems that contain the provided patch name.
patch_description={String}:
Filters systems that contain the provided patch description.
patch_status={String}:
Filters systems based on the patch status provided. (Applicable inputs: Missing, Failed, Installed).
patch_approval_status={String}:
Filters systems based on the provided patch approval status. (Applicable inputs: Approved, Unapproved).
install_error_code={String}:
Filters systems based on the installation error code provided.
fqdn_name={String}:
Filters systems based on the FQDN name provided.
patch_released_time={Numeric}:
Filters systems based on the patch release date provided.
installed_time={Numeric}:
Filters systems based on the provided patch installation time.
platform_name={String}:
Filters systems based on the platform provided.
severity={String}:
Filters systems based on the severity provided.
update_type={String}:
Filters systems 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).
patchid={Numeric}:
Filters systems based on the patch ID provided.
bulletinid={String}:
Filters systems based on the bulletin ID provided.
vendor_name={String}:
Filters systems based on the provided vendor name.
reboot_required={String}:
Filters systems based on the reboot option provided. (required, not required, autoreboot, may require).
cveids={String}:
Filters systems 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 computers per page.
Response Data
{ "metadata": { "pageLimit": 30, "totalRecords": "1", "totalPages": 1, "links": { "next": null, "prev": null }, "page": 1 }, "response_code": 200, "message_type": "systemreport", "message_response": { "systemreport": [ { "patches": [ { "severity": "Important", "patchname": "vcredist_x86_sp1.exe", "update_type": "Security Updates", "patch_id": "12621", "patch_description": "Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update", "vendor_name": "Microsoft", "install_error_code": "--", "fqdn_name": "WINV1RI92CIEGA.CSEZ.ZOHOCORPIN.COM", "patch_released_time": "1307989800000", "bulletinid": "MS11-025", "reboot_required": "may require", "platform_name": "Windows", "installed_time": "--", "deployment_remarks": "--", "patch_status": "Installed", "patch_approval_status": "approved" }, { "severity": "Important", "patchname": "vcredist_x64_sp1.exe", "update_type": "Security Updates", "patch_id": "12622", "patch_description": "Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update", "vendor_name": "Microsoft", "install_error_code": "--", "fqdn_name": "XXXXXX.ZZZZ.YYYY.COM", "patch_released_time": "1307989800000", "bulletinid": "MS11-025", "reboot_required": "may require", "platform_name": "Windows", "installed_time": "--", "deployment_remarks": "--", "patch_status": "Installed", "patch_approval_status": "approved" } ], "resource_id": "304" } ] }, "status": "success" }