Retrieves the list of all systems along with their patch scan status.
This API endpoint is deprecating soon
get /api/1.4/patch/scandetails
https://{serverurl}/api/1.4/patch/scandetails Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Unique ID of the system (resource) to filter by. Get the resource ID from Get All Systems api
Returns only the systems that belong to the given domain. Provide the domain name. Get the domain names from Get Domains api
Returns only the records of the given operating system platform. Accepted values: windows, mac, linux.
Returns only the systems that belong to the given remote office. Provide the remote office name. Get the remote office names from Get Remote Offices api
Returns only the systems that are members of the given custom group. Provide the custom group name. Get the custom group names from Get Custom Groups api
Returns only the systems with the given patch health 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.
Text to look up in the column given in searchcolumn. Use together with searchtype and searchcolumn.
Name of the column (field) in the response in which the search text is looked up. Use together with searchtype and searchvalue.
Type of search to be performed on the column, for example, contains. Search is applied only when searchtype, searchcolumn and searchvalue are all provided.
Direction in which the records are sorted. Allowed values: ASC (ascending) and DESC (descending). Use together with orderby.
Name of the column (field) in the response by which the records are sorted. Use together with sortorder.
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.
Returns only the systems with the given agent installation status. Accepted values: 21 - Not Installed, 22 - Installed.
Returns only the systems with the given patch scan status. Accepted values: 226 - Failed, 227 - In Progress, 228 - Success, 229 - Not Done.
curl --request GET \
--url https://appdomains/api/1.4/patch/scandetails \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Value: scandetails
Paginated scan details data
Total number of systems with scan data
Array of system scan detail objects
Computer name of the system
Unique resource identifier
Domain name of the system
Branch or remote office name
Branch office identifier
Scan status: 226=Failed, 227=InProgress, 228=Success, 229=NotScanned
Live status: 1=Live, 2=Down
Health: 0=Unknown, 1=Healthy, 2=Vulnerable, 3=Highly Vulnerable
Installation status code
Platform ID: 1=Windows, 2=Mac, 3=Linux
Platform name
Full operating system name
Service pack or OS version
Agent version installed
Timestamp of last scan attempt
Timestamp of last successful scan
IP address(es) of the system
MAC address(es) of the system
Scan result remarks
Records per page
Current page number
API version: 1.0
Operation status: success
Response code: 200
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
{
"message_type": "scandetails",
"message_response": {
"total": 26,
"limit": 25,
"page": 2,
"scandetails": [
{
"branch_office_name": "Local Office",
"resource.name": "XXXX-YY-ZZ-1",
"resource_health_status": 3,
"description": "--",
"branch_office_id": 1,
"os_language": 1,
"agent_installed_on": 1548677081796,
"os_platform_name": "Windows",
"pmreshealthstatus.resource_id": 47707,
"patchstatusdefn.label": "dc.common.SCANNING_COMPLETED",
"branchofficedetails.branch_office_id": 1,
"agent_installed_dir": "C:\\Program Files (x86)\\DesktopCentral_Agent\\",
"mac_address": "00:0c:29:7e:51:a7,46:15:cf:8f:af:8f,00:15:5d:79:ec:dd,",
"resource.domain_netbios_name": "WORKGROUP",
"service_pack": "Windows 10 Version 1803 (x64)",
"os_language_abbr": "en",
"resource.resource_id": 47707,
"scan_remarks_args": "--",
"os_platform_id": 1,
"owner": "--",
"configstatusdefn.label": "dc.db.som.status.installed_successfully",
"scan_status": 228,
"scan_remarks": "dc.patch.util.Scanning_completedsuccessfully",
"agentcontact.logged_on_users": "Administrator",
"os_platform": 1,
"oslanguage.languageid": 1,
"last_sync_time": 1552904282877,
"oslanguage.i18n": "dc.patch.patchinfo.English",
"ip_address": "XXX.XX.YYY.YYY,XXX.YY.XX.YY,XXX.YY.YY.X,",
"osflavor_id": 0,
"search_tag": "--",
"agent_version": "10.0.267.W",
"owner_email_id": "--",
"patchstatusdefn.image_name": "/images/success.png",
"installation_status": 22,
"resource_id": 47707,
"os_name": "Windows 10 Professional Edition (x64)",
"agentcontact.last_contact_time": 1552956951000,
"location": "--",
"computer_live_status": 1,
"agentcontact.last_bootup_time": 1552629463000,
"last_scan_time": 1552904526258,
"patchmgmtosinfo.resource_id": 47707,
"errorcodetokburl.kb_url": "--",
"last_successful_scan": 1552904526258,
"computer_status_update_time": 1552903541615
}
]
},
"message_version": "1.0",
"status": "success",
"response_code": 200
}
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"
}
![]()
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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.