# Retrieve Installed Patches Across Managed Systems **Deprecating soon** Retrieves a paginated list of patches that have been successfully installed across managed systems including severity, vendor, and installed system counts. ## Endpoint `GET /api/1.4/patch/installedpatches` ## Request ### Request URL `https://[{serverurl}](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)/api/1.4/patch/installedpatches` ### Scope `DesktopCentralCloud.PatchMgmt.READ` ### Header `Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52` ### Request Parameters #### Request Headers | Parameter | Type | Required | Value | |---|---|---|---| | Accept | string | Mandatory | `application/json` | #### Query Parameters | Parameter | Type | Required | Description | |---|---|---|---| | loginid | string | Optional | | | resource_id | string | Optional | `{resource_id}` - Unique identifier of the computer | | userid | string | Optional | | | username | string | Optional | | | ticket | string | Optional | | | customerid | string | Optional | | | customerName | string | Optional | | | customername | string | Optional | | | residfilter | integer | Optional | Filter computer with particular resource id | | domainfilter | string | Optional | Get domain list from `api/1.4/desktop/serverproperties` | | branchofficefilter | string | Optional | Get branch office list from `api/1.4/desktop/serverproperties` | | remoteofficefilter | string | Optional | | | customgroupfilter | string | Optional | Get custom group list from `api/1.4/desktop/serverproperties` | | livestatusfilter | integer | Optional | `1` - Live: System is working.
`2` - Down: System is not working.
`3` - Unknown: System status is not known. | | platformfilter | string | Optional | | | connidfilter | string | Optional | | | page | string | Optional | | | pagelimit | string | Optional | | | orderby | string | Optional | | | sortorder | string | Optional | | | sortcolumn | string | Optional | | | searchtype | string | Optional | | | searchcolumn | string | Optional | | | searchvalue | string | Optional | | | patchid | string | Optional | | | resid | string | Optional | `{resid}` - Unique identifier of the computer | | languagefilter | integer | Optional | | | approvalstatusfilter | integer | Optional | | | downloadstatusfilter | integer | Optional | | | supercedestatusfilter | integer | Optional | | | healthfilter | integer | Optional | | | severityfilter | integer | Optional | | | patchtypefilter | integer | Optional | | | patchstatusfilter | integer | Optional | | | agentinstallationstatusfilter | integer | Optional | | | installstatusfilter | integer | Optional | `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). | | licensetypefilter | integer | Optional | `1`: Commercial (used for business or paid purposes).
`2`: Non-commercial (used for personal or educational purposes).
`0`: Unidentified (license type not specified). | | scanstatusfilter | integer | Optional | `-1`: Not done scan has not started.
`0`: Failed scan failed.
`1`: In progress scan is ongoing.
`2`: Success scan completed successfully. | | deploymentstatusfilter | integer | Optional | | | configtypefilter | integer | Optional | | | accesstypefilter | integer | Optional | `1`: Allowed (access is permitted).
`2`: Prohibited (access is restricted).
`0`: Not assigned (no access configuration). | | compliancestatusfilter | integer | Optional | `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). | | complianceStatusFilter | integer | Optional | | | bulletinid | string | Optional | | | oscompatibilityfilter | string | Optional | `32-bit`: For 32-bit operating systems.
`64-bit`: For 64-bit operating systems. | | uninstallsupportfilter | string | Optional | `Yes`: Supports uninstallation.
`No`: Does not support uninstallation. | | installerformatfilter | string | Optional | `MSI`: Installed via MSI installer.
`EXE`: Installed via EXE installer. | | licensefilter | string | Optional | Get License List from `api/1.4/inventory/licenses?swid={softwareID}` in `license_id` parameter inside message response | | hardwaretypefilter | string | Optional | Get hardware type list from `api/1.4/inventory/filterparams` | | manufacturerfilter | string | Optional | Get hardware manufacturer list from `api/1.4/inventory/filterparams` | | osfilter | string | Optional | | | vendorfilter | string | Optional | | | policyname | string | Optional | | | configstatusfilter | string | Optional | | | viewtypefilter | string | Optional | | | latestpatches | string | Optional | | | prohibitedswid | string | Optional | Unique identifier of the prohibited software | | categoryfilter | string | Optional | | | ticketid | string | Optional | | ### Sample Request ```curl curl --request GET \ --url https://appdomains/api/1.4/patch/installedpatches \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' ``` ## Response Parameters ### HTTP Code 200 Response body: `application/json` | Attribute | Type | Description | |---|---|---| | `message_type` | string | Value: `installedpatches` | | `message_response` | JSON Object | Paginated installed patches data | | `message_version` | string | API version: `1.0` | | `status` | string | Operation status: `success` | | `response_code` | string | Response code: `200` | ### Sample Response: HTTP 200 Paginated installed patches ```json { "message_type": "installedpatches", "message_response": { "total": 26, "installedpatches": [ { "patch_id": 309239, "bulletin_id": "TU-075", "patch_name": "BANDIZIP-SETUP.EXE", "patch_description": "Bandizip (6.22.0.0)", "severity": 1, "installed": 48, "platform_name": "Windows", "update_name": "Third Party Updates", "patch_released_time": 1552974574000, "patch_uninstall_status": 0, "patch_size": 6537016, "vendor_name": "Bandisoft", "superceded_by": "NA" } ], "limit": 25, "page": 2 }, "message_version": "1.0", "status": "success", "response_code": 200 } ``` ### HTTP Code 401 Response body: `application/json` | Attribute | Type | Description | |---|---|---| | `errorCode` | long | Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required) | | `errorMsg` | string | Authentication failure reason | ### Sample Response: HTTP 401 Authentication credentials are missing, expired or invalid ```json { "error_code": "UAC_UNAUTHORIZED", "error_description": "dc.rest.authentication.unauthorized" } ``` ### HTTP Code 403 Response body: `application/json` | Attribute | Type | Description | |---|---|---| | `errorCode` | long | Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin) | | `errorMsg` | string | Message indicating insufficient privileges to access this resource | ### Sample Response: HTTP 403 Authenticated user lacks the required role or scope ```json { "errorCode": "FORBIDDEN", "errorMessage": "You do not have sufficient privileges to perform this operation" } ``` ### HTTP Code 429 Response body: `application/json` | Attribute | Type | Description | |---|---|---| | `errorCode` | long | 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 | | `errorMsg` | string | Rate limit exceeded message with retry guidance | ### Sample Response: HTTP 429 API call threshold exceeded ```json { "errorCode": "RATE_LIMIT_EXCEEDED", "errorMessage": "API call limit exceeded. Retry after the lock period elapses" } ``` ## Rate Limits ![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png) **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.