Retrieve Installed Patches Across Managed Systems 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 paginated list of patches that have been successfully installed across managed systems including severity, vendor, and installed system counts.

This API endpoint is deprecating soon

Endpoint

Request URL

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

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

loginidstringOptional

RoleId. Get Role Id

resource_idstringOptional

{resource_id} - Unique identifier of the computer

useridstringOptional

RoleId. Get Role Id

usernamestringOptional
ticketstringOptional
customeridstringOptional

RoleId. Get Role Id

customerNamestringOptional
customernamestringOptional
residfilterintegerOptional

Filter computer with particular resource id

domainfilterstringOptional

Get domain list from api/1.4/desktop/serverproperties

branchofficefilterstringOptional

Get branch office list from api/1.4/desktop/serverproperties

remoteofficefilterstringOptional
customgroupfilterstringOptional

Get custom group list from api/1.4/desktop/serverproperties

livestatusfilterintegerOptional

1 - Live: System is working.
2 - Down: System is not working.
3 - Unknown: System status is not known.

platformfilterstringOptional
connidfilterstringOptional

RoleId. Get Role Id

pagestringOptional
pagelimitstringOptional
orderbystringOptional
sortorderstringOptional
sortcolumnstringOptional
searchtypestringOptional
searchcolumnstringOptional
searchvaluestringOptional
patchidstringOptional

RoleId. Get Role Id

residstringOptional

{resid} - Unique identifier of the computer

languagefilterintegerOptional
approvalstatusfilterintegerOptional
downloadstatusfilterintegerOptional
supercedestatusfilterintegerOptional
healthfilterintegerOptional
severityfilterintegerOptional
patchtypefilterintegerOptional
patchstatusfilterintegerOptional
agentinstallationstatusfilterintegerOptional
installstatusfilterintegerOptional

21: Yet to install (agent has not been installed).
22: Installed (agent is currently installed).
23: Uninstalled (agent has been removed).
24: Yet to uninstall (marked for uninstallation but not yet removed).
29: Installation failure (an error occurred during installation).

licensetypefilterintegerOptional

1: Commercial (used for business or paid purposes).
2: Non-commercial (used for personal or educational purposes).
0: Unidentified (license type not specified).

scanstatusfilterintegerOptional

-1: Not done scan has not started.
0: Failed scan failed.
1: In progress scan is ongoing.
2: Success scan completed successfully.

deploymentstatusfilterintegerOptional
configtypefilterintegerOptional
accesstypefilterintegerOptional

1: Allowed (access is permitted).
2: Prohibited (access is restricted).
0: Not assigned (no access configuration).

compliancestatusfilterintegerOptional

0: Under licensed (fewer licenses than required).
1: Over licensed (more licenses than needed).
2: In compliance (license usage matches availability).
3: Expired (license validity has ended).
-1: Not available (compliance data is missing).

complianceStatusFilterintegerOptional
bulletinidstringOptional
oscompatibilityfilterstringOptional

32-bit: For 32-bit operating systems.
64-bit: For 64-bit operating systems.

uninstallsupportfilterstringOptional

Yes: Supports uninstallation.
No: Does not support uninstallation.

installerformatfilterstringOptional

MSI: Installed via MSI installer.
EXE: Installed via EXE installer.

licensefilterstringOptional

Get License List from api/1.4/inventory/licenses?swid={softwareID} in license_id parameter inside message response

hardwaretypefilterstringOptional

Get hardware type list from api/1.4/inventory/filterparams

manufacturerfilterstringOptional

Get hardware manufacturer list from api/1.4/inventory/filterparams

osfilterstringOptional
vendorfilterstringOptional
policynamestringOptional
configstatusfilterstringOptional
viewtypefilterstringOptional
latestpatchesstringOptional
prohibitedswidstringOptional

unique identifier of the prohibited software

categoryfilterstringOptional
ticketidstringOptional

Sample Request

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

Response Parameters

- HTTP code 200

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

Value: installedpatches

message_responseJSON Object

Paginated installed patches data

Show Sub-Attributes
totalstring

Total number of installed patches

installedpatchesJSON Array

Array of installed patch objects

Show Sub-Attributes
JSON Object
Show Sub-Attributes
patch_idlong

Unique patch identifier

bulletin_idstring

Security bulletin identifier

patch_namestring

Patch filename

patch_descriptionstring

Patch description

severitystring

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

installedstring

Count of systems where this patch is installed

platform_namestring

Platform name

update_namestring

Update category

patch_released_timelong

Patch release timestamp

patch_uninstall_statusstring

Uninstall: 0=Not Supported, 1=Supported

patch_sizelong

Patch file size in bytes

vendor_namestring

Vendor name

superceded_bystring

Superseding patch ID, or NA

patch_idlong

Unique patch identifier

bulletin_idstring

Security bulletin identifier

patch_namestring

Patch filename

patch_descriptionstring

Patch description

severitystring

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

installedstring

Count of systems where this patch is installed

platform_namestring

Platform name

update_namestring

Update category

patch_released_timelong

Patch release timestamp

patch_uninstall_statusstring

Uninstall: 0=Not Supported, 1=Supported

patch_sizelong

Patch file size in bytes

vendor_namestring

Vendor name

superceded_bystring

Superseding patch ID, or NA

limitstring

Records per page

pagestring

Current page number

totalstring

Total number of installed patches

installedpatchesJSON Array

Array of installed patch objects

Show Sub-Attributes
JSON Object
Show Sub-Attributes
patch_idlong

Unique patch identifier

bulletin_idstring

Security bulletin identifier

patch_namestring

Patch filename

patch_descriptionstring

Patch description

severitystring

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

installedstring

Count of systems where this patch is installed

platform_namestring

Platform name

update_namestring

Update category

patch_released_timelong

Patch release timestamp

patch_uninstall_statusstring

Uninstall: 0=Not Supported, 1=Supported

patch_sizelong

Patch file size in bytes

vendor_namestring

Vendor name

superceded_bystring

Superseding patch ID, or NA

patch_idlong

Unique patch identifier

bulletin_idstring

Security bulletin identifier

patch_namestring

Patch filename

patch_descriptionstring

Patch description

severitystring

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

installedstring

Count of systems where this patch is installed

platform_namestring

Platform name

update_namestring

Update category

patch_released_timelong

Patch release timestamp

patch_uninstall_statusstring

Uninstall: 0=Not Supported, 1=Supported

patch_sizelong

Patch file size in bytes

vendor_namestring

Vendor name

superceded_bystring

Superseding patch ID, or NA

limitstring

Records per page

pagestring

Current page number

message_versionstring

API version: 1.0

statusstring

Operation status: success

response_codestring

Response code: 200

Sample Response: HTTP 200

Paginated installed patches

Copied!
  {
    "response_code": 200,
    "message_type": "installedpatches",
    "message_response": {
      "total": 2307,
      "installedpatches": [
        {
          "severity": 1,
          "installed": 48,
          "patch_id": 309239,
          "patch_name": "BANDIZIP-SETUP.EXE",
          "patch_description": "Bandizip (6.22.0.0)",
          "vendor_name": "Bandisoft",
          "superceded_by": "NA",
          "bulletin_id": "TU-075",
          "update_name": "Third Party Updates",
          "patch_released_time": 1552974574000,
          "patch_size": 6537016,
          "patch_uninstall_status": 0,
          "platform_name": "Windows"
        }
      ],
      "limit": 25,
      "page": 1
    },
    "message_version": "1.0",
    "status": "success"
  }
▼ 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.

© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.