Retrieves all managed systems with their patch information.
get /dcapi/patch/reports/allSystems
https://{serverurl}/dcapi/patch/reports/allSystems 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. Provide a single numeric value.
Returns only the systems with the given agent live status. Accepted values: 1 - Live, 2 - Down, 3 - Unknown.
Returns only the systems with the given patch health (vulnerability) status. Accepted values: 0 - Not Available, 1 - Healthy, 2 - Vulnerable, 3 - Highly Vulnerable.
Unique identifier of the system (resource) to which the data needs to be filtered.
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
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/allSystems \
--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 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 entries
Last boot time in epoch milliseconds
Formatted last boot time
Last contact time in epoch milliseconds
Formatted last contact time
Last DS contact time in epoch, or -1
Formatted last DS contact time, or --
Currently logged on users
Transformed logged on users
Branch office identifier
Branch office name
Transformed branch office name
Branch member resource relation ID
Computer live status code
Status update time in epoch
Number of critical missing patches
Transformed critical patch count, or --
Customer identifier
Customer name
Customer info customer ID
Deployment status code
Transformed deployment status, or --
System description, or null
Transformed description, or --
Domain NetBIOS name
Transformed domain name
Fully qualified domain name
Friendly name of the computer
Transformed friendly name
Internationalization/language setting
Transformed language display
Number of important missing patches
Transformed important patch count, or --
Count of installed BIOS patches
Transformed installed BIOS patches count
Count of installed driver patches
Transformed installed driver patches count
Count of installed Microsoft patches
Transformed installed MS patches count
Count of installed third-party patches
Transformed installed TP patches count
IP address of the system
Transformed IP address
Last action initiated time, or null
Last operation performed, or null
Transformed last operation, or --
Last patched time in epoch, or -1
Formatted last patched time, or --
Last scan time in epoch milliseconds
Formatted last scan time
Last successful scan time in epoch
Formatted last successful scan, or --
Last sync time, or null
Location, or null
Transformed location, or --
Number of low-severity missing patches
Transformed low patch count, or --
MAC address
Transformed MAC address
Count of missing BIOS patches
Transformed missing BIOS patches count
Count of missing driver patches
Transformed missing driver patches count
Count of missing Microsoft patches
Transformed missing MS patches count
Count of missing third-party patches
Transformed missing TP patches count
Number of moderate-severity missing patches
Transformed moderate patch count, or --
OS language code
OS language abbreviation
Operating system name
Transformed OS name
OS platform code: 1=Windows, 2=Mac, 3=Linux
OS platform display name
Transformed platform name
OS flavor identifier
OS language identifier
System owner, or null
Owner email, or null
Transformed owner email, or --
Transformed owner, or --
Patch mgmt OS info resource ID
PM resource health status resource ID
PM resource patch count resource ID
Processor architecture code
Reboot required status, or null
Remarks, or null
Resource health status code
Transformed health status display
Resource identifier
Resource name
Transformed resource name
Resource-resource ID
Deployment status resource ID
Reboot details resource ID, or null
Scan remarks message key
Scan status code
Search tag, or null
Transformed search tag, or --
Service pack or OS version
Transformed service pack
Shutdown status, or null
Shutdown status update time, or null
Status image path
Status label
Timezone offset in minutes
Formatted timezone offset
Total BIOS patches count
Transformed total BIOS patches
Total driver patches count
Transformed total driver patches
Total Microsoft patches count
Transformed total MS patches
Total patches column value
Transformed total patches, or --
Total third-party patches count
Transformed total TP patches
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
All systems with patch data
{
"Links": {
"next": null,
"prev": null
},
"messageResponse": [
{
"agent_last_bootup_time": "1450070085000",
"agent_last_bootup_time_transform": "Dec 14, 2015 10:44 AM",
"agent_last_contact_time": "1741006238768",
"agent_last_contact_time_transform": "Mar 3, 2025 06:20 PM",
"agent_last_ds_contact_time": "-1",
"agent_last_ds_contact_time_transform": "--",
"agent_logged_on_users": "Browser Security Manager",
"agent_logged_on_users_transform": "Application Control Manager",
"branch_office_id": "16222000000238916",
"branch_office_name": "Default Remote Office",
"branch_office_name_transform": "Default Remote Office",
"branchmemberresourcerel_resource_id": "16222000000270139",
"computer_live_status": "3",
"computer_status_update_time": "1741006239168",
"critical_patch_count": "0",
"critical_patch_count_transform": "--",
"customer_id": "16222000000226138",
"customer_name": "ems-testingautomation+get_patch46",
"customerinfo_customer_id": "16222000000226138",
"deployment_status": "208",
"deployment_status_transform": "--",
"description": null,
"description_transform": "--",
"domain_netbios_name": "ZOHOCORP",
"domain_netbios_name_transform": "ZOHOCORP",
"fqdn_name": "WIN-HOST-01.example.com",
"friendly_name": "WinMachine4",
"friendly_name_transform": "WinMachine13",
"i18n": "Multilingual",
"i18n_transform": "Spanish",
"important_patch_count": "0",
"important_patch_count_transform": "--",
"installed_bios_patches": "0",
"installed_bios_patches_transform": "0",
"installed_driver_patches": "0",
"installed_driver_patches_transform": "0",
"installed_ms_patches": "2",
"installed_ms_patches_transform": "0",
"installed_tp_patches": "9",
"installed_tp_patches_transform": "0",
"ip_address": "192.0.2.18",
"ip_address_transform": "192.0.2.16",
"last_action_initiated_on": null,
"last_operation": null,
"last_operation_transform": "--",
"last_patched_time": "-1",
"last_patched_time_transform": "--",
"last_scan_time": "1741006279892",
"last_scan_time_transform": "Mar 3, 2025 06:21 PM",
"last_successful_scan": "1741006279892",
"last_successful_scan_transform": "--",
"last_sync_time": null,
"location": null,
"location_transform": "--",
"low_patch_count": "0",
"low_patch_count_transform": "--",
"mac_address": "d5:63:b0:a2:62",
"mac_address_transform": "d4:67:b7:a0:13",
"missing_bios_patches": "0",
"missing_bios_patches_transform": "0",
"missing_driver_patches": "0",
"missing_driver_patches_transform": "0",
"missing_ms_patches": "0",
"missing_ms_patches_transform": "0",
"missing_tp_patches": "0",
"missing_tp_patches_transform": "0",
"moderate_patch_count": "0",
"moderate_patch_count_transform": "--",
"os_language": "0",
"os_language_abbr": "co",
"os_name": "Windows 7 Professional Edition (x64)",
"os_name_transform": "Windows 11 Enterprise for Virtual Desktops (x64)",
"os_platform": "1",
"os_platform_name": "Windows",
"os_platform_name_transform": "Windows",
"osflavor_id": "0",
"oslanguage_languageid": "0",
"owner": null,
"owner_email_id": null,
"owner_email_id_transform": "--",
"owner_transform": "--",
"patchmgmtosinfo_resource_id": "16222000000270139",
"pmreshealthstatus_resource_id": "16222000000270139",
"pmresourcepatchcount_resource_id": "16222000000270139",
"processor_architecture": "0",
"reboot_req_status": null,
"remarks": null,
"resource_health_status": "1",
"resource_health_status_transform": "Not scanned",
"resource_id": "16222000000270139",
"resource_name": "WinMachine4",
"resource_name_transform": "WinMachine13",
"resource_resource_id": "16222000000270139",
"resourcedeploymentstatus_resource_id": "16222000000270139",
"resourcetorebootdetails_resource_id": null,
"scan_remarks": "dc.patch.util.Scanning_completedsuccessfully",
"scan_status": "228",
"search_tag": null,
"search_tag_transform": "--",
"service_pack": "Windows 7 SP1 (x64)",
"service_pack_transform": "Windows 11 Version 21H2 (x64)",
"shutdown_status": null,
"shutdown_status_update_time": null,
"status_image": "",
"status_label": "",
"timezone_offset": "-480",
"timezone_offset_transform": "GMT-8:0",
"total_bios_patches": "0",
"total_bios_patches_transform": "0",
"total_driver_patches": "0",
"total_driver_patches_transform": "0",
"total_ms_patches": "2",
"total_ms_patches_transform": "0",
"total_patches_column": "11",
"total_patches_column_transform": "--",
"total_tp_patches": "9",
"total_tp_patches_transform": "0"
}
],
"metadata": {
"limit": 25,
"page": 1
},
"status": "success",
"totalPages": 1,
"totalRecords": "1"
}
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.