Retrieve Patches Installed Across Managed Systems

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 paginated list of patches that have been successfully installed across managed systems, including severity, approval status, and system counts.

Request URL

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

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

branchOfficestringOptional

Branch office name filter

platformlongOptional

1: Windows, 2: Mac, 3: Linux

domainstringOptional

Domain name filter

severitylongOptional

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

customGroupstringOptional

Custom group name filter

patchStatuslongOptional

201: Installed, 202: Missing, 203: Failed

approvalStatuslongOptional

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

kbnumberstringOptional

KB number 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/installedPatches \
  --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 installed patch entries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
bulletin_idstring

Security bulletin identifier

bulletin_id_transformstring

Transformed bulletin ID

cps_status_idstring

CPS status ID code

first_namestring

Name of the user who approved the patch

first_name_transformstring

Transformed approving user name

installedstring

Number of systems where patch is installed

installed_transformstring

Transformed installed count

patch_descriptionstring

Full description of the patch

patch_description_transformstring

Transformed patch description

patch_idstring

Unique patch identifier

patch_id_transformstring

Transformed patch ID

patch_namestring

Patch file name

patch_name_transformstring

Transformed patch file name

patch_norebootstring

Reboot requirement code: 0=Not Required

patch_released_timestring

Patch release time in epoch milliseconds

patch_released_time_transformstring

Formatted patch release date

patch_sizestring

Patch file size in bytes

patch_size_transformstring

Formatted patch file size

patch_supported_timestring

Patch supported time in epoch milliseconds

patch_supported_time_transformstring

Formatted patch supported date

patch_uninstall_statusstring

Uninstall support status code

patch_uninstall_status_transformstring

Transformed uninstall status display

platformstring

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

platform_namestring

Platform display name

platform_name_transformstring

Transformed platform name

s_namestring

Severity display name

severitystring

Severity code

severity_namestring

Severity label key

severity_transformstring

Transformed severity display

sqnumberstring

Software version/sequence number

sqnumber_transformstring

Transformed version number

status_idstring

Approval status ID code

status_imagestring

Image path for approval status

status_labelstring

Approval status label key

status_label_transformstring

Transformed approval status display

superceded_bystring

Superceded by patch ID, or NA

superceded_by_transformstring

Transformed superceded by value

update_namestring

Update type name

update_name_transformstring

Transformed update type name

updated_timestring

Last updated time in epoch milliseconds

updated_time_transformstring

Formatted last updated date and time

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

Paginated installed patches report data

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "1",
    "messageResponse": [
      {
        "installed": "2",
        "updated_time": "1770718649504",
        "sqnumber": "915597",
        "bulletin_id_transform": "MAC-080",
        "platform_name_transform": "Mac",
        "status_label_transform": "Not Approved",
        "patch_supported_time_transform": "Jul 3, 2017",
        "bulletin_id": "AV-FCS03",
        "patch_noreboot": "0",
        "platform": "1",
        "update_name": "Definition Update",
        "updated_time_transform": "--",
        "first_name_transform": "--",
        "patch_released_time": "1734021181000",
        "patch_id_transform": "601171",
        "patch_size": "174147184",
        "patch_description_transform": "DiffMerge 4.2.1",
        "cps_status_id": "211",
        "status_id": "211",
        "patch_uninstall_status": "0",
        "platform_name": "Windows",
        "severity_transform": "Low",
        "first_name": "DC-SYSTEM-USER",
        "patch_size_transform": "10.28 MB",
        "patch_uninstall_status_transform": "Not Supported",
        "severity": "0",
        "patch_id": "400009",
        "patch_name": "mpam-fe-defender-x64.exe",
        "update_name_transform": "Third Party Updates",
        "patch_description": "The latest update for Microsoft Defender (1.421.755.0)",
        "patch_name_transform": "DiffMerge.4.2.1.1013.intel.stable.dmg",
        "sqnumber_transform": "4.2.1",
        "vendor_name": "Microsoft",
        "superceded_by": "NA",
        "severity_name": "dc.rep.patchreport.unrated",
        "vendor_name_transform": "SourceGear, LLC.",
        "patch_supported_time": "1734021181000",
        "status_label": "dc.common.APPROVED",
        "installed_transform": "2",
        "patch_released_time_transform": "Jul 3, 2017",
        "s_name": "Unrated",
        "superceded_by_transform": "NA",
        "status_image": "images/approved_icon.gif"
      }
    ],
    "totalPages": 2,
    "Links": {
      "next": "/dcapi/patch/reports/installedPatches?page=2&pageLimit=25",
      "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.