# Retrieve Scan Details Report Retrieves detailed patch scan information for managed systems. ## Endpoint `GET /dcapi/patch/reports/scanDetails` ## Request URL `https://[{serverurl}](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)/dcapi/patch/reports/scanDetails` ## Scope `DesktopCentralCloud.PatchMgmt.READ` ## Header `Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52` ## Request Parameters ### Query Parameters - **pageLimit** `integer` *(Optional)*: Number of records per page (default 25) - **page** `integer` *(Optional)*: Page number to retrieve (1-based) - **searchColumn** `string` *(Optional)*: Column name to search within - **searchValue** `string` *(Optional)*: Value to search for in the specified column - **branchOffice** `string` *(Optional)*: Branch office name filter - **platformId** `long` *(Optional)*: 1: Windows, 2: Mac, 3: Linux - **healthStatusId** `long` *(Optional)*: 0: Unknown, 1: Healthy, 2: Vulnerable, 3: Highly Vulnerable - **liveStatusId** `long` *(Optional)*: 1: Agent Live, 2: Agent Down - **installationStatus** `long` *(Optional)*: 21: Not Installed (agent is not installed), 22: Installed (agent is installed) - **cgId** `long` *(Optional)*: Custom group ID filter - **resourceId** `long` *(Optional)*: Specific resource ID filter - **scanStatus** `long` *(Optional)*: 226: Failed, 227: In Progress, 228: Success, 229: Not Scanned - **domain** `string` *(Optional)*: Domain name filter - **customGroupFilter** `string` *(Optional)*: Get Custom Group list from api/1.4/desktop/serverproperties - **kbnumber** `long` *(Optional)*: KB number filter - **isWebView** `string` *(Optional)*: Whether request is from web view - **skipColumns** `string` *(Optional)*: Comma-separated column names to exclude from response ## Sample Request ```curl curl --request GET \ --url https://appdomains/dcapi/patch/reports/scanDetails \ --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' ``` ## Response Parameters ### HTTP Code 200 #### Response Body — application/json - `JSON Object` - **metadata** `JSON Object`: Pagination metadata - **totalRecords** `string`: Total number of records matching the query - **messageResponse** `JSON Array`: Array of scan detail entries - **totalPages** `string`: Total number of pages available - **Links** `JSON Object`: Pagination links for next and previous pages - **status** `string`: Operation result: success ### HTTP Code 500 #### Response Body — application/json - `JSON Object` - **error_code** `string`: Error code: INTERNAL_ERROR for server-side failures - **error_description** `string`: Localized error description: dc.rest.api_internal_error ### Possible Response Codes - **200** `HTTP code` - **500** `HTTP code` ### Sample Response: HTTP 200 Detailed scan report ```json { "metadata": { "limit": 25, "page": 1 }, "totalRecords": "1", "messageResponse": [ { "resource_name_transform": "DESKTOP-3MGS2V0", "agent_version_transform": "11.5.2616.01.W", "oslanguage_languageid": "1", "resource_health_status": null, "branch_office_id": "1", "os_language": "1", "agent_installed_on": "1778777427871", "os_platform_name": "Windows", "owner_transform": "--", "service_pack": "Windows 11 Version 25H2 (x64)", "os_name_transform": "Windows 10 Education (x64)", "os_language_abbr": "en", "branchofficedetails_branch_office_id": "1", "domain_netbios_name_transform": "WORKGROUP", "os_platform_id": "1", "os_platform_name_transform": "Windows", "pmreshealthstatus_resource_id": null, "location_transform": "--", "scan_remarks": "dc.patch.util.Scanning_completedsuccessfully", "branch_office_name_transform": "Local Office", "i18n_transform": "French", "agent_last_contact_time_transform": "May 18, 2026 05:48 AM", "os_platform": "1", "agent_last_ds_contact_time": "0", "agent_logged_on_users": "pmp-test10", "osflavor_id": "0", "i18n": "dc.patch.patchinfo.English", "search_tag": "--", "status_label": "dc.db.som.status.installed_successfully", "error_kb_url": null, "owner_email_id": "--", "agent_installed_dir_transform": "C:\\Program Files (x86)\\ManageEngine\\UEMS_Agent\\", "installation_status": "22", "last_scan_time_transform": "May 17, 2026 08:56 PM", "friendly_name_transform": "DESKTOP-3MGS2V0", "scan_remarks_transform": "Scanning completed successfully", "last_successful_scan": "1779269204807", "branchmemberresourcerel_resource_id": "11", "computer_status_update_time": "1779101421159", "branch_office_name": "Local Office", "processor_architecture": "2", "agent_last_contact_time": "1779268735000", "description": null, "owner_email_id_transform": "--", "domain_netbios_name": "VMDRQA", "status_label_transform": "Installed Successfully", "patch_status_label": "dc.common.SCANNING_COMPLETED", "ip_address_transform": "192.168.130.129", "search_tag_transform": "--", "agent_installed_on_transform": "May 15, 2026 02:59 PM", "agent_last_bootup_time_transform": "May 16, 2026 01:04 AM", "agent_installed_dir": "C:\\Program Files (x86)\\ManageEngine\\UEMS_Agent\\", "mac_address": "0c:37:96:3c:69:48,00:15:5d:ae:26:77", "agent_last_ds_contact_time_transform": "--", "scan_remarks_args": null, "patch_status_label_transform": "Scanning Completed", "patchclientscanerror_resource_id": null, "owner": "--", "patch_scan_error_code": null, "friendly_name": "pmp-test10", "scan_status": "228", "description_transform": "--", "last_successful_scan_transform": "May 17, 2026 08:56 PM", "patch_status_image": "images/success.png", "last_sync_time": "1779273157893", "agent_logged_on_users_transform": "Administrateur", "ip_address": "10.72.70.236,172.19.64.1", "service_pack_transform": "Windows 10 Version 22H2 (x64)", "patchmgmtosinfo_resource_id": "11", "agent_version": "11.5.2616.01.W", "mac_address_transform": "00:0c:29:51:3e:f7", "resource_health_status_transform": "--", "agent_last_bootup_time": "1779042799000", "resource_id": "11", "os_name": "Windows 11 Professional Edition (x64)", "location": "--", "computer_live_status": "1", "resource_name": "pmp-test10", "last_scan_time": "1779269204807", "customer_id": "1" } ], "totalPages": 1, "Links": { "next": null, "prev": null }, "status": "success" } ``` ### Sample Response: HTTP 500 Server-side error ```json { "error_description": "dc.rest.api_internal_error", "error_code": "INTERNAL_ERROR" } ``` ## API Rate Limit ![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png) **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.