Retrieves a detailed system-level patch report for a specific managed system.
get /dcapi/patch/reports/systemReport
https://{serverurl}/dcapi/patch/reports/systemReport Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Number of records to be returned per page. Minimum 1, maximum 1000. Default is 25.
Page number of the result set to be returned. Minimum 1, maximum 100000. Default is 1.
Name of the column in which the search value needs to be looked up. Use together with searchValue.
Text to look up in the column given in searchColumn. Use together with searchColumn.
Returns only the patches with the given status on the systems. Accepted values: 201 - Installed, 202 - Missing. Multiple values can be given as a comma-separated list.
Returns only the patches with the given approval status. Accepted values: 211 - Approved, 0 - Not Approved, 212 - Declined.
Returns only the records of the given operating system platform. Accepted values: 1 - Windows, 2 - Mac, 3 - Linux.
Returns only the patches of the given severity. Accepted values: 0 - Unrated, 1 - Low, 2 - Moderate, 3 - Important, 4 - Critical. Provide a single numeric value.
Unique identifier of the system (resource) to which the data needs to be filtered. Get the value from Get All Systems
Indicates whether the response is requested for the web console. Set to True to get the response in the format used by the web console; leave empty for the default API response.
Comma-separated list of column names that should be left out of the response, to get a lighter response with only the columns you need.
View filter ID for saved custom view
Array of filter criteria for the report view
Column identifier for the filter criterion
Comparison operator (e.g., equals, contains, greater_than)
Custom comparator override for special filter logic
Logical operator to combine with next criterion (AND/OR)
curl --request GET \
--url https://appdomains/dcapi/patch/reports/systemReport \
--header 'Accept: application/patchReports.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'content-type: application/json' \
--data '{}' {
"dcViewFilterID": 0,
"criteriaJSON": [
{
"columnID": 0,
"searchValue": [
"string"
],
"comparator": "string",
"customComparator": "string",
"logicalOperator": "string"
}
]
}
Pagination links for next and previous pages
URL for the next page of results, or null if on the last page
URL for the previous page of results, or null if on the first page
Array of system report entries
Affected patch status code
Resource ID for affected patch status
First name of the user who approved the patch
Transformed display value of approving user name
Security bulletin identifier
Transformed bulletin ID display value
Collection name, or null if not assigned
Transformed collection name display, -- if null
Configuration ID, or null if not configured
Customer identifier
Patch ID from customer patch status
Deployment remarks, or null
Deployment remarks arguments, or null
Transformed deployment remarks, -- if null
Deployment status, or null
Download status, or null
First name of the deploying user, or null
Transformed deploying user name, -- if null
Install error code, or null
Installed time in epoch, or null
Transformed installed time display, -- if null
Patch ID from install status, or null
Resource ID from install status, or null
Image path for affected patch status
Label key for affected patch status
Full description of the patch
Transformed patch description
Image path for download status, or null
Label for download status, or null
Unique patch identifier
Transformed patch ID
Image path for install status, or null
Label for install status, or null
Patch file name
Transformed patch name
Reboot requirement code: 0=May Require, 1=Not Required
Transformed reboot requirement display
Patch release time in epoch milliseconds
Formatted patch release date
Patch status code
Patch supported time in epoch milliseconds
Formatted patch supported date
Patch type code
Uninstall support status code
Transformed uninstall status: Supported, Not Supported
Last updated time in epoch milliseconds
Formatted last updated date and time
Platform code: 1=Windows, 2=Mac, 3=Linux
Platform display name
Severity display name
Resource identifier
Severity code
Severity label key
Transformed severity display
Image path for approval status
Label key for approval status
Transformed approval status display
Superceded by patch ID, or NA
Update type ID
Update type name
Transformed update type name
Vendor name
Transformed vendor name
Pagination metadata
Operation result: success
Total number of pages available
Total number of records matching the query
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
Error code: INTERNAL_ERROR for server-side failures
Localized error description: dc.rest.api_internal_error
System-level patch report
{
"Links": {
"next": null,
"prev": null
},
"messageResponse": [
{
"affected_patch_status": "201",
"affectedpatchstatus_resource_id": "16222000000271157",
"approveduser_first_name": "DC-SYSTEM-USER",
"approveduser_first_name_transform": "DC-SYSTEM-USER",
"bulletin_id": "MS22-JAN14",
"bulletin_id_transform": "BI-001",
"collection_name": null,
"collection_name_transform": "--",
"config_id": null,
"customer_id": "16222000000226138",
"customerpatchstatus_patch_id": "32830",
"deploy_remarks": null,
"deploy_remarks_args": null,
"deploy_remarks_transform": "--",
"deployment_status": null,
"download_status": null,
"first_name": null,
"first_name_transform": "--",
"install_error_code": null,
"installed_time": null,
"installed_time_transform": "--",
"installpatchstatus_patch_id": null,
"installpatchstatus_resource_id": null,
"patch_affected_status_image": "images/success.gif",
"patch_affected_status_label": "dc.common.INSTALLED",
"patch_description": "KB5009719, 2022-01 Security and Quality Rollup for .NET Framework 4.5.2 for Windows 7 for x64 (KB5008860) (ESU)",
"patch_description_transform": "ChengMing 3900 (1.26.0)",
"patch_download_status_image": null,
"patch_download_status_label": null,
"patch_id": "32830",
"patch_id_transform": "1414963",
"patch_install_status_image": null,
"patch_install_status_label": null,
"patch_name": "Ndp45-kb5008860-x64.exe",
"patch_name_transform": "ChengMing_3900_3901_01.26.00.exe",
"patch_noreboot": "0",
"patch_noreboot_transform": "May Require",
"patch_released_time": "1641924028000",
"patch_released_time_transform": "Nov 6, 2024",
"patch_status": "211",
"patch_supported_time": "1641934828000",
"patch_supported_time_transform": "Nov 7, 2024",
"patch_type": "7",
"patch_uninstall_status": "0",
"patch_uninstall_status_transform": "Not Supported",
"patch_updated_time": "1770718649504",
"patch_updated_time_transform": "Feb 10, 2026 03:47 PM",
"platform": "1",
"platform_name": "Windows",
"pmseverity_name": "Important",
"resource_id": "16222000000271157",
"severity": "3",
"severity_name": "dc.common.IMPORTANT",
"severity_transform": "Critical",
"status_image": "images/approved_icon.gif",
"status_label": "dc.common.APPROVED",
"status_label_transform": "Approved",
"superceded_by": "NA",
"update_id": "7",
"update_name": "Rollups",
"update_name_transform": "BIOS",
"vendor_name": "Microsoft",
"vendor_name_transform": "Dell"
}
],
"metadata": {
"limit": 25,
"page": 1
},
"status": "success",
"totalPages": 1,
"totalRecords": "1"
}
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"
}
Server-side error
{
"error_code": "INTERNAL_ERROR",
"error_description": "dc.rest.api_internal_error"
}
![]()
Duration: 1 minute | Threshold: 50 | 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.