Retrieves the patch-to-system mapping report showing installation status of patches across all applicable systems.
get /dcapi/patch/reports/allPatchDetails
https://{serverurl}/dcapi/patch/reports/allPatchDetails 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 patches of the given severity. Accepted values: 0 - Unrated, 1 - Low, 2 - Moderate, 3 - Important, 4 - Critical. Provide a single numeric value.
Returns only the records of the given language. Provide the language ID as listed in Endpoint Central.
Unique identifier of the patch whose details need to be retrieved. Get the value from Get Supported Patches
Unique identifier of the system (resource) whose details need to be retrieved. Get the value from Get All Systems
Returns only the patches of the given update type, for example, Security Updates, Non-Security Updates, Service Packs, Feature Packs, Rollups, Drivers or Definition Updates. Provide a single numeric value.
Returns only the deployments with the given status. Accepted values: 206 - Failed, 207 - Reboot Pending, 209 - Installed.
Returns only the patches with the given status on the systems. Accepted values: 201 - Installed, 202 - Missing. Provide a single numeric value.
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 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 released under the given bulletin. A bulletin is the vendor advisory a patch is published under, for example MS15-041. Enter the Bulletin ID exactly as shown in the patch list. Get the bulletin ID from Get Supported Patches.
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/allPatchDetails \
--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 patch-system mapping entries
Affected patch status code
Agent last bootup time in epoch milliseconds
Agent last contact time in epoch milliseconds
Formatted agent last contact time
Logged on users on the agent
Transformed logged on users
Agent version string
Transformed agent version
Branch office name
Transformed branch office name
Security bulletin identifier
Transformed bulletin ID
Collection name, or null
Transformed collection name
Computer live status code
Computer status update time in epoch milliseconds
Configuration ID, or null
Transformed configuration ID
Deployment remarks, or null
Deployment remarks arguments, or null
Transformed deployment remarks
Deployer first name, or null
Transformed deployer name
Deployment status, or null
Domain NetBIOS name
Transformed domain name
Name of the user who approved the patch
Transformed approving user name
Friendly computer name
Transformed friendly name
Internationalization language
Transformed i18n value
Image path for approval status
Installation error code, or null
Installation time in epoch milliseconds, or null
Formatted installation time
IP address of the system
Transformed IP address
Approval status label key
Transformed approval status display
MAC address of the system
Transformed MAC address
Managed computer resource ID
OS language code
Operating system name
Transformed OS name
OS platform code
Image path for patch affected status
Patch affected status label key
Transformed patch affected status
Full description of the patch
Transformed patch description
Unique patch identifier
Transformed patch ID
Image path for install status, or null
Install status label, or null
Transformed install status label
Patch file name
Transformed patch file name
Patch release time in epoch milliseconds
Formatted patch release date
Patch file size in bytes
Formatted patch file size
Patch status code
Patch supported time in epoch milliseconds
Formatted patch supported date
Patch type code
Uninstall support status code
Transformed uninstall status display
Last updated time in epoch milliseconds
Formatted last updated date and time
Platform code: 1=Windows, 2=Mac, 3=Linux
Platform display name
Severity display name
Resource identifier
Resource/computer name
Transformed resource name
Resource MAC/IP resource ID
Service pack version
Transformed service pack
Severity code
Severity label key
Transformed severity display
Software version/sequence number
Transformed version number
Superceded by patch ID, or NA
Transformed superceded by value
Update type name
Transformed update type name
User ID of approver
Vendor name
Transformed vendor name
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 patch details
{
"Links": {
"next": "/dcapi/patch/reports/allPatchDetails?page=2&pageLimit=25",
"prev": null
},
"messageResponse": [
{
"affected_patch_status": "201",
"agent_last_bootup_time": "1450070085000",
"agent_last_contact_time": "1741006571814",
"agent_last_contact_time_transform": "Mar 3, 2025 06:20 PM",
"agent_logged_on_users": "Device Control Manager",
"agent_logged_on_users_transform": "Application Control Manager",
"agent_version": "10.0.337.L",
"agent_version_transform": "10.0.337.L",
"branch_office_name": "localOfficeOne",
"branch_office_name_transform": "Default Remote Office",
"bulletin_id": "ALAS-2024-2540",
"bulletin_id_transform": "ELSA-2024-6964",
"collection_name": null,
"collection_name_transform": "--",
"computer_live_status": "3",
"computer_status_update_time": "1741006572973",
"config_id": null,
"config_id_transform": "--",
"deploy_remarks": null,
"deploy_remarks_args": null,
"deploy_remarks_transform": "--",
"deployer_first_name": null,
"deployer_first_name_transform": "--",
"deployment_status": null,
"domain_netbios_name": "linuxosgroup",
"domain_netbios_name_transform": "ZOHOCORP",
"first_name": "DC-SYSTEM-USER",
"first_name_transform": "DC-SYSTEM-USER",
"friendly_name": "LinuxMachine6",
"friendly_name_transform": "LinuxMachine1",
"i18n": "Multilingual",
"i18n_transform": "Multilingual",
"image_name": "images/approved_icon.gif",
"install_error_code": null,
"installed_time": null,
"installed_time_transform": "--",
"ip_address": "192.0.2.20",
"ip_address_transform": "192.0.2.21",
"label": "dc.common.APPROVED",
"label_transform": "Approved",
"mac_address": "d4:30:b2:a6:54",
"mac_address_transform": "d7:36:b5:a0:02",
"managedcomputer_resource_id": "16222000000277697",
"os_language": "0",
"os_name": "CentOS 7",
"os_name_transform": "Ubuntu 24.10",
"os_platform": "3",
"patch_affected_status_image": "images/success.gif",
"patch_affected_status_label": "dc.common.INSTALLED",
"patch_affected_status_label_transform": "Missing",
"patch_description": "java-1.8.0-openjdk Security Update (ALAS-2024-2540)",
"patch_description_transform": "Libguestfs update (ELSA-2024-6964)",
"patch_id": "2803597",
"patch_id_transform": "1633087",
"patch_install_status_image": null,
"patch_install_status_label": null,
"patch_install_status_label_transform": "--",
"patch_name": "java-1.8.0-openjdk-accessibility-1.8.0.412.b08-1.amzn2.0.1.x86_64.rpm",
"patch_name_transform": "libguestfs-1.44.0-9.0.2.module+el8.9.0+90052+d3bf71d8.x86_64.rpm",
"patch_released_time": "1715193000000",
"patch_released_time_transform": "Sep 24, 2024",
"patch_size": "112504",
"patch_size_transform": "768.04 KB",
"patch_status": "211",
"patch_supported_time": "1717830298631",
"patch_supported_time_transform": "Sep 27, 2024",
"patch_type": "2",
"patch_uninstall_status": "0",
"patch_uninstall_status_transform": "Not Supported",
"patch_updated_time": "1770718649504",
"patch_updated_time_transform": "Feb 10, 2026 03:47 PM",
"platform": "3",
"platform_name": "Linux",
"pmseverity_name": "Low",
"resource_id": "16222000000277697",
"resource_name": "LinuxMachine6",
"resource_name_transform": "LinuxMachine1",
"resourcemacip_resource_id": "16222000000277697",
"service_pack": "--",
"service_pack_transform": "--",
"severity": "1",
"severity_name": "dc.common.LOW",
"severity_transform": "Moderate",
"sqnumber": "ALAS-2024-2540",
"sqnumber_transform": "ELSA-2024-6964",
"superceded_by": "NA",
"superceded_by_transform": "NA",
"update_name": "Third Party Updates",
"update_name_transform": "Third Party Updates",
"user_id": "16222000000226118",
"vendor_name": "Openjdk-8",
"vendor_name_transform": "virt"
}
],
"metadata": {
"limit": 25,
"page": 1
},
"status": "success",
"totalPages": 40,
"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.