Provides various summaries related to the patch module including health status, scan summary, and other key metrics.
This API endpoint is deprecating soon
View new endpoint >https://{serverurl}/api/1.4/patch/summary Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Text to look up in the column given in searchcolumn. Use together with searchtype and searchcolumn.
Name of the column (field) in the response in which the search text is looked up. Use together with searchtype and searchvalue.
Type of search to be performed on the column, for example, contains. Search is applied only when searchtype, searchcolumn and searchvalue are all provided.
Direction in which the records are sorted. Allowed values: ASC (ascending) and DESC (descending). Use together with orderby.
Name of the column (field) in the response by which the records are sorted. Use together with sortorder.
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.
curl --request GET \
--url https://appdomains/api/1.4/patch/summary \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Value: summary
Patch module summary data
Top-level summary object containing all sub-summaries
Patch-level summary with counts
Total installed patches across all systems
Total applicable patches
Newly released patches
Total missing patches
Missing patches grouped by severity
Missing patches with Critical severity
Missing patches with Important severity
Missing patches with Moderate severity
Missing patches with Low severity
Missing patches with no severity rating
Total missing patches across all severities
System health summary
Total managed systems
Systems with healthy patch status
Systems with moderate vulnerability
Systems with high vulnerability
Systems with unknown health status
Scan status summary
Total systems that have been scanned
Systems never scanned
Systems with successful last scan
Systems with failed last scan
Vulnerability database update status
Timestamp of last vulnerability DB update
Status of last DB update: Success or Failed
Timestamp of next scheduled DB update
Whether automatic DB updates are disabled
Whether a DB update is currently in progress: true or false
APD tasks summary
Total number of APD tasks configured
Timestamp of last scheduled APD task, null if none
Timestamp of next scheduled APD task, null if none
Name of last executed APD task, null if none
Name of next APD task to execute, null if none
API version: 1.0
Operation status: success
Response code: 200
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
{
"message_type": "summary",
"message_response": {
"summary": {
"patch_summary": {
"installed_patches": 2307,
"applicable_patches": 3921,
"new_patches": 369,
"patch_summary_report_generation_time": 0,
"missing_patches": 1614
},
"missing_patch_severity_summary": {
"moderate_count": 68,
"unrated_count": 589,
"total_count": 1614,
"critical_count": 293,
"important_count": 568,
"low_count": 96
},
"apd_summary": {
"last_task_scheduled_time": null,
"next_task_scheduled_time": null,
"number_of_apd_tasks": 33,
"last_executed_task": null,
"next_task": null
},
"system_summary": {
"total_systems": 97,
"moderately_vulnerable_systems": 0,
"healthy_systems": 35,
"system_summary_report_generation_time": 0,
"highly_vulnerable_systems": 61,
"health_unknown_systems": 1
},
"patch_scan_summary": {
"scan_summary_report_generation_time": 0,
"unscanned_system_count": 2,
"scanned_systems": 95,
"scan_success_count": 37,
"scan_failure_count": 58
},
"vulnerability_db_summary": {
"last_db_update_status": "Success",
"next_db_update_scheduled_time": 1553058600000,
"is_auto_db_update_disabled": false,
"db_update_in_progress": "false",
"last_db_update_time": 0
}
}
},
"message_version": "1.0",
"status": "success",
"response_code": 200
}
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.