Retrieves detailed patch scan information for managed systems.
get /dcapi/patch/reports/scanDetails
https://{serverurl}/dcapi/patch/reports/scanDetails Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Number of records to be returned per page. Minimum 1, maximum 1000. Default is 25.
Page number of the result set to be returned. Minimum 1, maximum 100000. Default is 1.
Name of the column in which the search value needs to be looked up. Use together with searchValue.
Text to look up in the column given in searchColumn. Use together with searchColumn.
Returns only the systems that belong to the given remote office (branch office). Provide the remote office name as configured in Endpoint Central. Multiple values can be given as a comma-separated list. Get the remote office names from Get Remote Offices api
Returns only the records of the given operating system platform. Accepted values: 1 - Windows, 2 - Mac, 3 - Linux.
Returns only the systems with the given patch health (vulnerability) status. Accepted values: 0 - Not Available, 1 - Healthy, 2 - Vulnerable, 3 - Highly Vulnerable.
Returns only the systems with the given agent live status. Accepted values: 1 - Live, 2 - Down, 3 - Unknown.
Returns only the entries with the given installation status.
Unique identifier of the custom group whose systems need to be considered. Get the custom group ID from Get Custom Groups api
Unique identifier of the system (resource) to which the data needs to be filtered. Get the value from Get All Systems
Returns only the systems with the given patch scan status. Accepted values: 226 - Failed, 227 - In Progress, 228 - Success, 229 - Not Done.
Returns only the systems that belong to the given domain or workgroup. Provide the domain name as shown in Endpoint Central, for example, the NetBIOS name of the domain. Multiple values can be given as a comma-separated list. Get the domain names from Get Domains api
Returns only the systems that are members of the given custom group. Provide the custom group name as configured in Endpoint Central. Multiple values can be given as a comma-separated list. Get the custom group names from Get Custom Groups api
Returns only the patches whose KB (knowledge base) article number contains the given value. For example, 5031356. Partial values are matched.
Indicates whether the response is requested for the web console. Set to True to get the response in the format used by the web console; leave empty for the default API response.
Comma-separated list of column names that should be left out of the response, to get a lighter response with only the columns you need.
View filter ID for saved custom view
Array of filter criteria for the report view
Column identifier for the filter criterion
Comparison operator (e.g., equals, contains, greater_than)
Custom comparator override for special filter logic
Logical operator to combine with next criterion (AND/OR)
curl --request GET \
--url https://appdomains/dcapi/patch/reports/scanDetails \
--header 'Accept: application/patchReports.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'content-type: application/json' \
--data '{}' {
"dcViewFilterID": 0,
"criteriaJSON": [
{
"columnID": 0,
"searchValue": [
"string"
],
"comparator": "string",
"customComparator": "string",
"logicalOperator": "string"
}
]
}
Pagination metadata
Total number of records matching the query
Array of scan detail entries
Transformed resource/computer name
Transformed agent version string
OS language ID
Resource health status code, or null
Branch office ID
OS language code
Agent installation time in epoch milliseconds
OS platform name (Windows, Mac, Linux)
Transformed owner name, or --
OS service pack or version details
Transformed OS name
OS language abbreviation (e.g., en, fr)
Branch office details ID
Transformed domain NetBIOS name
OS platform ID
Transformed OS platform name
PM resource health status resource ID, or null
Transformed location, or --
Scan remarks i18n key
Transformed branch office name
Transformed internationalization language name
Formatted agent last contact time
OS platform code
Agent last distribution server contact time in epoch milliseconds
Currently logged on users
OS flavor ID
Internationalization language key
Search tag, or --
Installation status label key
Error KB article URL, or null
Owner email address, or --
Transformed agent installation directory path
Installation status code
Formatted last scan time
Transformed friendly name
Transformed scan remarks text
Last successful scan time in epoch milliseconds
Branch member resource relation ID
Computer status update time in epoch milliseconds
Branch office name
Processor architecture code
Agent last contact time in epoch milliseconds
Computer description, or null
Transformed owner email, or --
Domain NetBIOS name
Transformed installation status label
Patch scan status label key
Transformed IP address
Transformed search tag, or --
Formatted agent installation date
Formatted agent last bootup time
Agent installation directory path
MAC address(es), comma-separated
Formatted last DS contact time, or --
Scan remarks arguments, or null
Transformed patch scan status label
Patch client scan error resource ID, or null
Owner name, or --
Patch scan error code, or null
Friendly name of the resource
Scan status code
Transformed description, or --
Formatted last successful scan time
Patch status image path
Last sync time in epoch milliseconds
Transformed logged on users
IP address(es), comma-separated
Transformed service pack/OS version
Patch management OS info resource ID
Agent version string
Transformed MAC address
Transformed resource health status, or --
Agent last bootup time in epoch milliseconds
Unique resource identifier
Full OS name
Location of the system, or --
Computer live status code
Resource name
Last scan time in epoch milliseconds
Customer ID
Total number of pages available
Pagination links for next and previous pages
URL for the next page of results, or null if on the last page
URL for the previous page of results, or null if on the first page
Operation result: success
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
Message indicating insufficient privileges to access this resource
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
Rate limit exceeded message with retry guidance
Error code: INTERNAL_ERROR for server-side failures
Localized error description: dc.rest.api_internal_error
Detailed scan report
{
"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.0.2.13",
"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": "192.0.2.14,192.0.2.15",
"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"
}
Authentication credentials are missing, expired or invalid
{
"error_code": "UAC_UNAUTHORIZED",
"error_description": "dc.rest.authentication.unauthorized"
}
Authenticated user lacks the required role or scope
{
"errorCode": "FORBIDDEN",
"errorMessage": "You do not have sufficient privileges to perform this operation"
}
API call threshold exceeded
{
"errorCode": "RATE_LIMIT_EXCEEDED",
"errorMessage": "API call limit exceeded. Retry after the lock period elapses"
}
Server-side error
{
"error_code": "INTERNAL_ERROR",
"error_description": "dc.rest.api_internal_error"
}
![]()
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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.