Retrieves the system health report based on patch management metrics.
get /dcapi/patch/reports/systemHealth
https://{serverurl}/dcapi/patch/reports/systemHealth 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 systems or patches belonging to the given operating system platform. Accepted values: 1 - Windows, 2 - Mac, 3 - Linux. Multiple values can be given as a comma-separated list.
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 with the given patch health (vulnerability) status. Accepted values: 0 - Not Available, 1 - Healthy, 2 - Vulnerable, 3 - Highly Vulnerable. Multiple values can be given as a comma-separated list.
Returns only the systems whose operating system language matches the given language. Multiple values can be given as a comma-separated list.
curl --request GET \
--url https://appdomains/dcapi/patch/reports/systemHealth \
--header 'Accept: application/systemHealth.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'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
Array of system health entries
Name of the computer
Number of critical missing patches
Friendly display name of the device
Domain name of the computer
Health status: Healthy, Vulnerable, Highly Vulnerable
Number of important missing patches
Count of installed BIOS patches
Count of installed driver patches
Count of installed OS patches
Count of installed third-party patches
IP address of the system
Language of the operating system
Last boot time of the system
Last time the agent contacted the server
Last contacted time with distribution server, or --
Last time a patch was applied, or --
Last scan time
Last successful scan time
Location of the system, or --
Currently logged on users
Number of low-severity missing patches
MAC address of the system
Count of missing BIOS patches
Count of missing driver patches
Count of missing OS patches
Count of missing third-party patches
Number of moderate-severity missing patches
Admin notes, or --
Full operating system name
Platform: Windows, Mac, Linux
Owner of the system, or --
Email of the system owner, or --
Deployment remarks, or --
Remote office name
Search tag, or --
Service pack or OS version
Shutdown or restart remarks, or --
Timezone of the system
Total BIOS patches count
Total driver patches count
Total OS patches count
Total patches count
Total third-party patches count
Pagination metadata
Operation result: success
Total number of pages available
Total number of records matching the query
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
System health report
{
"Links": {
"next": "/dcapi/patch/reports/systemHealth?page=2&pageLimit=25",
"prev": null
},
"messageResponse": [
{
"ComputerName": "WinMachine4",
"Critical": "0",
"DeviceFriendlyName": "WinMachine4",
"Domain": "ZOHOCORP",
"Health": "Healthy",
"Important": "0",
"InstalledBiosPatches": "0",
"InstalledDriverPatches": "0",
"InstalledOsPatches": "2",
"InstalledTpPatches": "9",
"IpAddress": "192.0.2.18",
"Language": "Multilingual",
"LastBootTime": "Dec 14, 2015 10:44 AM",
"LastContactTime": "Mar 3, 2025 06:20 PM",
"LastContactedTimeWithDs": "--",
"LastPatchedTime": "--",
"LastScan": "Mar 3, 2025 06:21 PM",
"LastSuccessfulScan": "Mar 3, 2025 06:21 PM",
"Location": "--",
"LoggedOnUsers": "Browser Security Manager",
"Low": "0",
"MacAddress": "d5:63:b0:a2:62",
"MissingBiosPatches": "0",
"MissingDriverPatches": "0",
"MissingOsPatches": "0",
"MissingTpPatches": "0",
"Moderate": "0",
"Notes": "--",
"OperatingSystem": "Windows 7 Professional Edition (x64)",
"OsPlatform": "Windows",
"Owner": "--",
"OwnerEmail": "--",
"Remarks": "--",
"RemoteOffice": "Default Remote Office",
"SearchTag": "--",
"ServicePack": "Windows 7 SP1 (x64)",
"Shutdown/restartRemarks": "--",
"TimeZone": "GMT-8:0",
"TotalBiosPatches": "0",
"TotalDriverPatches": "0",
"TotalOsPatches": "2",
"TotalPatches": "11",
"TotalTpPatches": "9"
},
{
"ComputerName": "MacMachine1",
"Critical": "1",
"DeviceFriendlyName": "MacMachine1",
"Domain": "ZOHOCORP",
"Health": "Highly Vulnerable",
"Important": "3",
"InstalledBiosPatches": "0",
"InstalledDriverPatches": "0",
"InstalledOsPatches": "0",
"InstalledTpPatches": "5",
"IpAddress": "192.0.2.19",
"Language": "Multilingual",
"LastBootTime": "Dec 14, 2015 10:44 AM",
"LastContactTime": "Mar 3, 2025 06:20 PM",
"LastContactedTimeWithDs": "--",
"LastPatchedTime": "--",
"LastScan": "Mar 3, 2025 06:21 PM",
"LastSuccessfulScan": "Mar 3, 2025 06:21 PM",
"Location": "--",
"LoggedOnUsers": "Administrator",
"Low": "0",
"MacAddress": "d5:07:b3:a0:26",
"MissingBiosPatches": "0",
"MissingDriverPatches": "0",
"MissingOsPatches": "0",
"MissingTpPatches": "7",
"Moderate": "0",
"Notes": "--",
"OperatingSystem": "Mac OS X - Mojave",
"OsPlatform": "Mac",
"Owner": "--",
"OwnerEmail": "--",
"Remarks": "--",
"RemoteOffice": "Default Remote Office",
"SearchTag": "--",
"ServicePack": "Mac OS X - Mojave 10.14.1",
"Shutdown/restartRemarks": "--",
"TimeZone": "GMT-8:0",
"TotalBiosPatches": "0",
"TotalDriverPatches": "0",
"TotalOsPatches": "0",
"TotalPatches": "12",
"TotalTpPatches": "12"
}
],
"metadata": {
"limit": 25,
"page": 1
},
"status": "success",
"totalPages": 2,
"totalRecords": 2
}
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.