Retrieves detailed audit-level information about a specific patch installation status across all applicable systems.
This API endpoint is deprecating soon
get /api/1.4/patch/patchdetails
https://{serverurl}/api/1.4/patch/patchdetails Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
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.
Unique ID of the patch. Fetch from Get Supported Patches
Unique ID of the system (resource). Fetch from Get All Systems
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 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 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 Supported 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 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.
Returns only the records of the given operating system platform. Accepted values: windows, mac, linux.
curl --request GET \
--url https://appdomains/api/1.4/patch/patchdetails \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Value: patchdetails
Paginated patch-level audit data per system
Total number of patch detail records
Array of patch detail objects per system
Resource ID of the system
Computer name
Domain name
System IP address
Operating system name
Service pack or OS version
Unique patch identifier
Patch filename or KB name
Detailed patch description
Security bulletin identifier
Severity level: 0=Unrated, 1=Low, 2=Moderate, 3=Important
Human-readable severity name
Update type: Security Updates, Third Party Updates, etc.
Patch vendor name
Patch release timestamp
Patch file size in bytes
Patch ID that supersedes this patch, or NA
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
Patch details with system-level status
{
"message_type": "patchdetails",
"message_response": {
"total": 26,
"patchdetails": [
{
"resource_id": 50924,
"resource.name": "COMPUTER-01",
"resource.domain_netbios_name": "DOMAIN",
"ip_address": "192.0.2.10",
"os_name": "Windows Server 2012 R2 Standard Edition (x64)",
"service_pack": "Windows Server 2012 R2 Gold (x64)",
"patch_id": 23956,
"patch_name": "SQLPreReqHandler_KB4057116_x64.exe",
"patch_description": "Security update for SQL Server 2012 SP4 x64 (KB4057116)",
"bulletin_id": "MS18-JAN9",
"severity": 3,
"pmseverity.name": "Important",
"update_name": "Security Updates",
"vendor_name": "Microsoft",
"patch_released_time": 1515715200000,
"patch_size": 0,
"superceded_by": "NA"
}
],
"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: 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.