This API provides detailed information about the installation status of a given patch on all applicable computers within the Endpoint Central environment.
This API endpoint is deprecating soon
View new endpoint >get /api/1.4/patch/allpatchdetails
https://{serverurl}/api/1.4/patch/allpatchdetails Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Unique ID of the patch to filter by. Get the patch ID from Get All Patches 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. Get the bulletin ID from Get All Patches api.
Returns only the patches of the given severity. Accepted values: 0 - Unrated, 1 - Low, 2 - Moderate, 3 - Important, 4 - Critical.
Returns only the patches with the given status on the systems. Accepted values: 201 - Installed, 202 - Missing.
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
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 patches released for the given language. Provide the language ID as listed in Endpoint Central.
Returns only the patches of the given update type. Accepted values: 0 - Security Updates, 1 - Non-Security Updates, 2 - Third Party Updates, 4 - Definition Updates, 5 - Service Packs, 6 - Feature Packs, 7 - Rollups, 8 - Tools, 9 - Drivers, 10 - Optional Updates, 11 - Preview Rollups, 12 - BIOS.
Returns only the configurations with the given deployment status. Accepted values: 3 - In Progress, 6 - Succeeded, 10 - In Progress with Failures, 12 - Yet to Deploy, 16 - Failed.
curl --request GET \
--url https://appdomains/api/1.4/patch/allpatchdetails \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Value: allpatchdetails
Paginated patch status per system
Total number of patch-system records
Array of patch detail objects per system
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
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": "allpatchdetails",
"message_response": {
"total": 26,
"allpatchdetails": [
{
"branch_office_name": "Local Office",
"patch_updated_time": 1552563514708,
"resource.name": "patch-abc-12-1",
"installstatusdefn.label": "--",
"sqnumber": "4057116",
"os_language": 1,
"install_error_code": "--",
"bulletin_id": "MS18-JAN9",
"update_name": "Security Updates",
"deploy_remarks": "--",
"patch_released_time": 1515715200000,
"patch_size": 0,
"patch_uninstall_status": 0,
"resource.domain_netbios_name": "DCPATCH",
"service_pack": "Windows Server 2012 R2 Gold (x64)",
"approvestatusdefn.image_name": "/images/approved_icon.gif",
"affectedpatchstatusdefn.image_name": "/images/success.gif",
"patch_type": 0,
"resource.resource_id": 50924,
"first_name": "DC-SYSTEM-USER",
"pmseverity.name": "Important",
"patch_status": 211,
"severity": 3,
"patch_id": 23956,
"patch_name": "SQLPreReqHandler_KB4057116_x64.exe",
"collection.collection_name": "--",
"patch_description": "Security update for SQL Server 2012 Service Pack 4 x64 (KB4057116)",
"approvestatusdefn.label": "dc.common.APPROVED",
"oslanguage.i18n": "dc.patch.patchinfo.English",
"deployment_status": "--",
"vendor_name": "Microsoft",
"superceded_by": "NA",
"severity_name": "dc.common.IMPORTANT",
"resourcemacip.resource_id": 50924,
"ip_address": "192.0.2.10",
"deployer.first_name": "--",
"installstatusdefn.image_name": "--",
"patch_supported_time": 1518615106000,
"affectedpatchstatusdefn.label": "dc.common.INSTALLED",
"agent_version": "10.0.267.W",
"user_id": 2,
"resource_id": 50924,
"os_name": "Windows Server 2012 R2 Standard Edition (x64)",
"deploy_remarks_args": "--",
"installed_time": "--"
}
],
"limit": 25,
"page": 2
},
"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: 5 | Lock period: 1 minute
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.