Fetches a list of systems along with their corresponding patch details, with support for extensive filtering.
get /dcapi/threats/systemreport/patches
https://{serverurl}/dcapi/threats/systemreport/patches Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Page number of the result set to be returned. Minimum 1, maximum 1000.
Returns only the patches that fix the given CVE ID. Example: CVE-2024-21412.
Returns only the patches with the given reboot requirement. Accepted values: required, not required, autoreboot, may require.
Returns only the patches released by the given vendor. Example: Microsoft. Get the vendor name from Get Supported Patches api.
Returns only the patches of the given update type. (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)
Returns only the patches of the given severity. Accepted values: Unrated, Low, Moderate, Important, Critical.
Returns only the patches of the given operating system platform. Accepted values: Windows, Mac, Linux.
Returns only the patches released at the given time. Provide the release time as epoch milliseconds. Multiple values can be given as a comma-separated list.
Returns only the patches with the given status on the systems. Accepted values: Missing, Failed, Installed.
Returns only the patches whose description contains the given text. Example: Security Update for Windows.
Returns only the patches whose name contains the given text. Example: KB5034441. Get patch names from Get Supported Patches api.
Returns only the patches that belong to the given security bulletin. Provide the bulletin ID published by the vendor, for example, MS15-041 or TU-636. Get the bulletin ID from Get Supported Patches api.
Filters patches based on the patch ID provided. Fetch from Get Supported Patches
Filters systems based on the resource ID provided. Fetch from Get All Systems
Returns only the patches with the given approval status. (Applicable inputs: Approved, Unapproved)
Deployment status of the patch on the system
Returns only the systems where patch installation failed with the given error code.
Returns only the systems with the given fully qualified domain name (FQDN).
Returns only the systems where the patch was installed at the given time, in epoch milliseconds.
Number of patches to be returned per page. Minimum 1, maximum 500.
curl --request GET \
--url https://appdomains/dcapi/threats/systemreport/patches \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Contains the systemreport array
Array of system report objects, each containing a resource_id and its patches
Array of patch objects for this system
Security bulletin identifier (e.g., TU-636, MS15-041)
Deployment remarks, or -- if none
Deployment status, or -- if not deployed
Installation error code, or -- if none
Patch installation timestamp, or -- if not installed
Approval status: approved, unapproved, declined
Full description of the patch
Unique patch identifier
Patch release timestamp in milliseconds since epoch
Patch status on this system: Missing, Failed, Installed
Patch file name
Target platform: Windows, Mac, Linux
Reboot requirement: required, not required, autoreboot, may require
Patch severity: Critical, Important, Moderate, Low, Unrated
Patch type: Security Updates, Non-Security Updates, Third Party Updates, Definition Update, Service Packs
Vendor name (e.g., Microsoft, Lamantine Software)
Unique resource identifier for the system
Response type identifier: systemreport
Pagination metadata including page info and navigation links
Number of records per page
Total number of matching records as a string
Total number of pages available
Pagination navigation links
URL for the next page, or null if on the last page
URL for the previous page, or null if on the first page
Current page number
Response code: 200 for success
Operation result: success
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
Message indicating insufficient privileges to access this resource
Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes
Rate limit exceeded message with retry guidance
{
"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": "WIN-HOST-02.example.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"
}
Authentication credentials are missing, expired or invalid
{
"error_code": "UAC_UNAUTHORIZED",
"error_description": "dc.rest.authentication.unauthorized"
}
Authenticated user lacks the required role or scope
{
"errorCode": "FORBIDDEN",
"errorMessage": "You do not have sufficient privileges to perform this operation"
}
API call threshold exceeded
{
"errorCode": "RATE_LIMIT_EXCEEDED",
"errorMessage": "API call limit exceeded. Retry after the lock period elapses"
}
![]()
Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes
Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.