# Retrieve All Applicable Patches Retrieves a comprehensive list of all patches applicable to systems, with extensive filter support for targeted querying. ## Endpoint `GET /dcapi/threats/patches` ## Request ### Request URL `https://{serverurl}/dcapi/threats/patches` ### Scope `DesktopCentralCloud.PatchMgmt.READ` ### Header `Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52` ### Request Parameters #### Request Headers - **Accept** `string` — **Mandatory** - `application/json` #### Query Parameters - **page** `string` — Optional - Page number of the result set to be returned. Minimum 1, maximum 1000. - **cveids** `string` — Optional - Returns only the patches that fix the given CVE ID. Example: CVE-2024-21412. - **reboot_required** `string` — Optional - Returns only the patches with the given reboot requirement. Accepted values: required, not required, autoreboot, may require. - **vendor_name** `string` — Optional - Returns only the patches released by the given vendor. Example: Microsoft. Get the vendor name from [Get Supported Patches](https://www.manageengine.com/products/desktop-central/help/api/cloud/patch-report-get-supported-patches-report.html) api. - **update_type** `string` — Optional - Returns only the patches of the given update type. (Applicable inputs: Security Updates, Non-Security Updates, Third-Party Updates, Definition Update, Service Packs, Feature Packs, Rollups, Tools, Driver, Optional Updates, Preview Rollups and BIOS) - **severity** `string` — Optional - Returns only the patches of the given severity. Accepted values: Unrated, Low, Moderate, Important, Critical. - **platform_name** `string` — Optional - Returns only the patches of the given operating system platform. Accepted values: Windows, Mac, Linux. - **patch_released_time** `string` — Optional - Returns only the patches released at the given time. Provide the release time as epoch milliseconds. Multiple values can be given as a comma-separated list. - **patch_status** `string` — Optional - Returns only the patches with the given status on the systems. Accepted values: Missing, Failed, Installed. - **patch_description** `string` — Optional - Returns only the patches whose description contains the given text. Example: Security Update for Windows. - **patchname** `string` — Optional - Returns only the patches whose name contains the given text. Example: KB5034441. Get patch names from [Get Supported Patches](https://www.manageengine.com/products/desktop-central/help/api/cloud/patch-report-get-supported-patches-report.html) api. - **bulletinid** `string` — Optional - Returns only the patches that belong to the given security bulletin. Provide the bulletin ID published by the vendor, for example, MS15-041 or TU-636. Get the bulletin ID from [Get Supported Patches](https://www.manageengine.com/products/desktop-central/help/api/cloud/patch-report-get-supported-patches-report.html) api. - **patchid** `string` — Optional - Filters patches based on the patch ID provided. Fetch from [Get Supported Patches](https://www.manageengine.com/products/desktop-central/help/api/cloud/patch-report-get-supported-patches-report.html). - **patch_uninstall** `string` — Optional - Filters patches based on the patch uninstallation support (as specified by the vendor). - **updated_time** `string` — Optional - Filters patches based on the approved time. - **kb_number** `string` — Optional - Filters patches based on the provided KB number. - **supercededby** `string` — Optional - ID of the patch that supersedes this patch. - **patch_supported_time** `string` — Optional - Filters patches based on the provided patch support date. - **patch_size** `string` — Optional - Filters patches based on the provided size. - **approveduser_first_name** `string` — Optional - Filters patches based on the post-deployment reboot option configured. (Applicable inputs: required, not required, autoreboot, may require) - **download_status** `string` — Optional - Filters patches based on the download status provided. - **installed_system_count** `string` — Optional - Number of systems on which the patch is installed. - **missing_system_count** `string` — Optional - Number of systems on which the patch is missing. - **failed_system_count** `string` — Optional - Number of systems on which the patch installation failed. - **pageLimit** `string` — Optional - Number of patches to be returned per page. Minimum 1, maximum 1000. ### Sample Request ```curl curl --request GET \ --url https://appdomains/dcapi/threats/patches \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' ``` ## Response Parameters ### HTTP 200 Response Body — `application/json` - `JSON Object` - **message_response** `JSON Object` - Contains the patches array. - **message_type** `string` - Response type identifier: patches. - **metadata** `JSON Object` - Pagination metadata including page info and navigation links. - **response_code** `string` - Response code: 200 for success. - **status** `string` - Operation result: success. ### HTTP 401 Response Body — `application/json` - `JSON Object` - **errorCode** `long` - Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required). - **errorMsg** `string` - Authentication failure reason. ### HTTP 403 Response Body — `application/json` - `JSON Object` - **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. ### HTTP 429 Response Body — `application/json` - `JSON Object` - **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 200 ```json { "metadata": { "pageLimit": 30, "totalRecords": "2", "totalPages": 1, "links": { "next": null, "prev": null }, "page": 1 }, "response_code": 200, "message_type": "patches", "message_response": { "patches": [ { "severity": "Important", "patchname": "vcredist_x86_sp1.exe", "updated_time": "1704363395117", "update_type": "Security Updates", "patch_description": "Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update", "kb_number": "2565063", "vendor_name": "Microsoft", "installed_system_count": 1, "supercededby": "NA", "patch_released_time": "1307989800000", "patch_supported_time": "1307989800000", "patch_size": "8993744", "patchid": "12621", "patch_uninstall": "not supported", "bulletinid": "MS11-025", "approveduser_first_name": "DC-SYSTEM-USER", "reboot_required": "may require", "platform_name": "Windows", "download_status": "--", "missing_system_count": 0, "failed_system_count": 0, "patch_status": "approved" }, { "severity": "Important", "patchname": "vcredist_x64_sp1.exe", "updated_time": "1704363395117", "update_type": "Security Updates", "patch_description": "Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update", "kb_number": "2565063", "vendor_name": "Microsoft", "installed_system_count": 1, "supercededby": "NA", "patch_released_time": "1307989800000", "patch_supported_time": "1307989800000", "patch_size": "10274136", "patchid": "12622", "patch_uninstall": "not supported", "bulletinid": "MS11-025", "approveduser_first_name": "DC-SYSTEM-USER", "reboot_required": "may require", "platform_name": "Windows", "download_status": "--", "missing_system_count": 0, "failed_system_count": 0, "patch_status": "approved" } ] }, "status": "success" } ``` ### Sample Response: HTTP 401 Authentication credentials are missing, expired or invalid. ```json { "error_code": "UAC_UNAUTHORIZED", "error_description": "dc.rest.authentication.unauthorized" } ``` ### 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" } ``` ### 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 **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.