# Retrieve Systems and Patch Details Fetches a list of systems along with their corresponding patch details, with support for extensive filtering. ## Endpoint `GET /dcapi/threats/systemreport/patches` ## Request URL `https://`[*{serverurl}*](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)`/dcapi/threats/systemreport/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. - **patch_id** `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) - **resource_id** `string` — Optional Filters systems based on the resource ID provided. Fetch from [Get All Systems](https://www.manageengine.com/products/desktop-central/help/api/cloud/system-report-get-all-systems-report.html) - **patch_approval_status** `string` — Optional Returns only the patches with the given approval status. (Applicable inputs: Approved, Unapproved) - **deployment_status** `string` — Optional Deployment status of the patch on the system - **install_error_code** `string` — Optional Returns only the systems where patch installation failed with the given error code. - **fqdn_name** `string` — Optional Returns only the systems with the given fully qualified domain name (FQDN). - **installed_time** `string` — Optional Returns only the systems where the patch was installed at the given time, in epoch milliseconds. - **pageLimit** `string` — Optional Number of patches to be returned per page. Minimum 1, maximum 500. ## Sample Request ```bash curl --request GET \ --url https://appdomains/dcapi/threats/systemreport/patches \ --header 'Accept: application/json' \ --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' ``` ## Response Parameters ### HTTP Code 200 Response body: `application/json` - `JSON Object` - **message_response** `JSON Object` Contains the systemreport array - **message_type** `string` Response type identifier: systemreport - **metadata** `JSON Object` Pagination metadata including page info and navigation links - **response_code** `string` Response code: 200 for success - **status** `string` Operation result: success ### Sample Response: HTTP 200 ```json { "metadata": { "pageLimit": 30, "totalRecords": "1", "totalPages": 1, "links": { "next": null, "prev": null }, "page": 1 }, "response_code": 200, "message_type": "systemreport", "message_response": { "systemreport": [ { "patches": [ { "severity": "Important", "patchname": "vcredist_x86_sp1.exe", "update_type": "Security Updates", "patch_id": "12621", "patch_description": "Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update", "vendor_name": "Microsoft", "install_error_code": "--", "fqdn_name": "WIN-HOST-02.example.com", "patch_released_time": "1307989800000", "bulletinid": "MS11-025", "reboot_required": "may require", "platform_name": "Windows", "installed_time": "--", "deployment_remarks": "--", "patch_status": "Installed", "patch_approval_status": "approved" }, { "severity": "Important", "patchname": "vcredist_x64_sp1.exe", "update_type": "Security Updates", "patch_id": "12622", "patch_description": "Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update", "vendor_name": "Microsoft", "install_error_code": "--", "fqdn_name": "XXXXXX.ZZZZ.YYYY.COM", "patch_released_time": "1307989800000", "bulletinid": "MS11-025", "reboot_required": "may require", "platform_name": "Windows", "installed_time": "--", "deployment_remarks": "--", "patch_status": "Installed", "patch_approval_status": "approved" } ], "resource_id": "304" } ] }, "status": "success" } ``` ### HTTP Code 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 ### 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` - `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 ### 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` - `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 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.