Retrieve Patch Details Summary Deprecating soon

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

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   >

Endpoint

Request URL

https://{serverurl}/api/1.4/patch/summary Copied!

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

searchvaluestringOptional

Text to look up in the column given in searchcolumn. Use together with searchtype and searchcolumn.

searchcolumnstringOptional

Name of the column (field) in the response in which the search text is looked up. Use together with searchtype and searchvalue.

searchtypestringOptional

Type of search to be performed on the column, for example, contains. Search is applied only when searchtype, searchcolumn and searchvalue are all provided.

sortorderstringOptional

Direction in which the records are sorted. Allowed values: ASC (ascending) and DESC (descending). Use together with orderby.

orderbystringOptional

Name of the column (field) in the response by which the records are sorted. Use together with sortorder.

pagelimitstringOptional

Number of records to be returned per page. Minimum 1, maximum 1000. Default is 25.

pageintegerOptional

Page number of the result set to be returned. Minimum 1, maximum 100000. Default is 1.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/api/1.4/patch/summary \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
message_typestring

Value: summary

message_responseJSON Object

Patch module summary data

Show Sub-Attributes
summaryJSON Object

Top-level summary object containing all sub-summaries

Show Sub-Attributes
patch_summaryJSON Object

Patch-level summary with counts

Show Sub-Attributes
installed_patchesstring

Total installed patches across all systems

applicable_patchesstring

Total applicable patches

new_patchesstring

Newly released patches

missing_patchesstring

Total missing patches

missing_patch_severity_summaryJSON Object

Missing patches grouped by severity

Show Sub-Attributes
critical_countstring

Missing patches with Critical severity

important_countstring

Missing patches with Important severity

moderate_countstring

Missing patches with Moderate severity

low_countstring

Missing patches with Low severity

unrated_countstring

Missing patches with no severity rating

total_countstring

Total missing patches across all severities

system_summaryJSON Object

System health summary

Show Sub-Attributes
total_systemsstring

Total managed systems

healthy_systemsstring

Systems with healthy patch status

moderately_vulnerable_systemsstring

Systems with moderate vulnerability

highly_vulnerable_systemsstring

Systems with high vulnerability

health_unknown_systemsstring

Systems with unknown health status

patch_scan_summaryJSON Object

Scan status summary

Show Sub-Attributes
scanned_systemsstring

Total systems that have been scanned

unscanned_system_countstring

Systems never scanned

scan_success_countstring

Systems with successful last scan

scan_failure_countstring

Systems with failed last scan

vulnerability_db_summaryJSON Object

Vulnerability database update status

Show Sub-Attributes
last_db_update_timelong

Timestamp of last vulnerability DB update

last_db_update_statusstring

Status of last DB update: Success or Failed

next_db_update_scheduled_timelong

Timestamp of next scheduled DB update

is_auto_db_update_disabledboolean

Whether automatic DB updates are disabled

db_update_in_progressstring

Whether a DB update is currently in progress: true or false

apd_summaryJSON Object

APD tasks summary

Show Sub-Attributes
number_of_apd_tasksstring

Total number of APD tasks configured

last_task_scheduled_timestring

Timestamp of last scheduled APD task, null if none

next_task_scheduled_timestring

Timestamp of next scheduled APD task, null if none

last_executed_taskstring

Name of last executed APD task, null if none

next_taskstring

Name of next APD task to execute, null if none

message_versionstring

API version: 1.0

statusstring

Operation status: success

response_codestring

Response code: 200

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

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

errorMsgstring

Rate limit exceeded message with retry guidance

Sample Response: HTTP 200

Copied!
  {
    "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
  }
                
▼ Show full

Sample Response: HTTP 401

Authentication credentials are missing, expired or invalid

Copied!
  {
    "error_code": "UAC_UNAUTHORIZED",
    "error_description": "dc.rest.authentication.unauthorized"
  }
                
▼ Show full

Sample Response: HTTP 403

Authenticated user lacks the required role or scope

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMessage": "You do not have sufficient privileges to perform this operation"
  }
                
▼ Show full

Sample Response: HTTP 429

API call threshold exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMessage": "API call limit exceeded. Retry after the lock period elapses"
  }
                
▼ Show full

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.