Retrieve Detailed System-Level Patch Report 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

Retrieves a detailed system-level patch report for a specific managed system.

This API endpoint is deprecating soon

Endpoints

Request URL

https://{serverurl}/dcapi/patch/reports/systemReport

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

pageLimitintegerOptional

Number of records per page (default 25)

pageintegerOptional

Page number to retrieve (1-based)

searchColumnstringOptional

Column name to search within

searchValuestringOptional

Value to search for in the specified column

patchStatusstringOptional

201: Installed, 202: Missing, 203: Failed

approveStatuslongOptional

211: Approved, 0: Not Approved, 212: Declined

platFormIdlongOptional

1: Windows, 2: Mac, 3: Linux

severitylongOptional

0: Unrated, 1: Low, 2: Moderate, 3: Important, 4: Critical

resourceIdlongOptional

Specific resource ID filter

isWebViewstringOptional

Whether request is from web view

skipColumnsstringOptional

Comma-separated column names to exclude from response

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/patch/reports/systemReport \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Pagination links for next and previous pages

Show Sub-Attributes
nextstring

URL for the next page of results, or null if on the last page

prevstring

URL for the previous page of results, or null if on the first page

messageResponseJSON Array

Array of system report entries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
affected_patch_statusstring

Affected patch status code

affectedpatchstatus_resource_idstring

Resource ID for affected patch status

approveduser_first_namestring

First name of the user who approved the patch

approveduser_first_name_transformstring

Transformed display value of approving user name

bulletin_idstring

Security bulletin identifier

bulletin_id_transformstring

Transformed bulletin ID display value

collection_namestring

Collection name, or null if not assigned

collection_name_transformstring

Transformed collection name display, -- if null

config_idstring

Configuration ID, or null if not configured

customer_idstring

Customer identifier

customerpatchstatus_patch_idstring

Patch ID from customer patch status

deploy_remarksstring

Deployment remarks, or null

deploy_remarks_argsstring

Deployment remarks arguments, or null

deploy_remarks_transformstring

Transformed deployment remarks, -- if null

deployment_statusstring

Deployment status, or null

download_statusstring

Download status, or null

first_namestring

First name of the deploying user, or null

first_name_transformstring

Transformed deploying user name, -- if null

install_error_codestring

Install error code, or null

installed_timestring

Installed time in epoch, or null

installed_time_transformstring

Transformed installed time display, -- if null

installpatchstatus_patch_idstring

Patch ID from install status, or null

installpatchstatus_resource_idstring

Resource ID from install status, or null

patch_affected_status_imagestring

Image path for affected patch status

patch_affected_status_labelstring

Label key for affected patch status

patch_descriptionstring

Full description of the patch

patch_description_transformstring

Transformed patch description

patch_download_status_imagestring

Image path for download status, or null

patch_download_status_labelstring

Label for download status, or null

patch_idstring

Unique patch identifier

patch_id_transformstring

Transformed patch ID

patch_install_status_imagestring

Image path for install status, or null

patch_install_status_labelstring

Label for install status, or null

patch_namestring

Patch file name

patch_name_transformstring

Transformed patch name

patch_norebootstring

Reboot requirement code: 0=May Require, 1=Not Required

patch_noreboot_transformstring

Transformed reboot requirement display

patch_released_timestring

Patch release time in epoch milliseconds

patch_released_time_transformstring

Formatted patch release date

patch_statusstring

Patch status code

patch_supported_timestring

Patch supported time in epoch milliseconds

patch_supported_time_transformstring

Formatted patch supported date

patch_typestring

Patch type code

patch_uninstall_statusstring

Uninstall support status code

patch_uninstall_status_transformstring

Transformed uninstall status: Supported, Not Supported

patch_updated_timestring

Last updated time in epoch milliseconds

patch_updated_time_transformstring

Formatted last updated date and time

platformstring

Platform code: 1=Windows, 2=Mac, 3=Linux

platform_namestring

Platform display name

pmseverity_namestring

Severity display name

resource_idstring

Resource identifier

severitystring

Severity code

severity_namestring

Severity label key

severity_transformstring

Transformed severity display

status_imagestring

Image path for approval status

status_labelstring

Label key for approval status

status_label_transformstring

Transformed approval status display

superceded_bystring

Superceded by patch ID, or NA

update_idstring

Update type ID

update_namestring

Update type name

update_name_transformstring

Transformed update type name

vendor_namestring

Vendor name

vendor_name_transformstring

Transformed vendor name

metadataJSON Object

Pagination metadata

Show Sub-Attributes
limitstring

Number of records per page

pagestring

Current page number

statusstring

Operation result: success

totalPagesstring

Total number of pages available

totalRecordsstring

Total number of records matching the query

- HTTP code 500

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

Error code: INTERNAL_ERROR for server-side failures

error_descriptionstring

Localized error description: dc.rest.api_internal_error

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

System-level patch report

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "1",
    "messageResponse": [
      {
        "update_id": "7",
        "patch_download_status_label": null,
        "patch_noreboot_transform": "May Require",
        "install_error_code": null,
        "bulletin_id": "MS22-JAN14",
        "patch_noreboot": "0",
        "update_name": "Rollups",
        "patch_download_status_image": null,
        "patch_description_transform": "ChengMing 3900 (1.26.0)",
        "patch_uninstall_status": "0",
        "download_status": null,
        "patch_updated_time_transform": "Feb 10, 2026 03:47 PM",
        "patch_status": "211",
        "patch_uninstall_status_transform": "Not Supported",
        "patch_install_status_image": null,
        "patch_id": "32830",
        "patch_name": "Ndp45-kb5008860-x64.exe",
        "update_name_transform": "BIOS",
        "patch_description": "KB5009719, 2022-01 Security and Quality Rollup for .NET Framework 4.5.2 for Windows 7 for x64 (KB5008860) (ESU)",
        "patch_name_transform": "ChengMing_3900_3901_01.26.00.exe",
        "vendor_name": "Microsoft",
        "superceded_by": "NA",
        "status_label": "dc.common.APPROVED",
        "config_id": null,
        "deploy_remarks_args": null,
        "patch_released_time_transform": "Nov 6, 2024",
        "installed_time": null,
        "collection_name": null,
        "affectedpatchstatus_resource_id": "16222000000271157",
        "deploy_remarks_transform": "--",
        "patch_affected_status_image": "images/success.gif",
        "collection_name_transform": "--",
        "patch_updated_time": "1770718649504",
        "installed_time_transform": "--",
        "bulletin_id_transform": "BI-001",
        "status_label_transform": "Approved",
        "patch_supported_time_transform": "Nov 7, 2024",
        "deploy_remarks": null,
        "platform": "1",
        "first_name_transform": "--",
        "patch_released_time": "1641924028000",
        "installpatchstatus_patch_id": null,
        "patch_id_transform": "1414963",
        "approveduser_first_name_transform": "DC-SYSTEM-USER",
        "platform_name": "Windows",
        "severity_transform": "Critical",
        "customerpatchstatus_patch_id": "32830",
        "patch_type": "7",
        "first_name": null,
        "affected_patch_status": "201",
        "severity": "3",
        "pmseverity_name": "Important",
        "deployment_status": null,
        "severity_name": "dc.common.IMPORTANT",
        "vendor_name_transform": "Dell",
        "patch_supported_time": "1641934828000",
        "patch_install_status_label": null,
        "patch_affected_status_label": "dc.common.INSTALLED",
        "approveduser_first_name": "DC-SYSTEM-USER",
        "resource_id": "16222000000271157",
        "customer_id": "16222000000226138",
        "installpatchstatus_resource_id": null,
        "status_image": "images/approved_icon.gif"
      }
    ],
    "totalPages": 1,
    "Links": {
      "next": null,
      "prev": null
    },
    "status": "success"
  }
▼ Show full

Sample Response: HTTP 500

Server-side error

Copied!
  {
    "error_description": "dc.rest.api_internal_error",
    "error_code": "INTERNAL_ERROR"
  }
▼ Show full

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.