Uninstalls specified patches from all applicable systems.
post /api/1.4/patch/uninstallpatch
https://{serverurl}/api/1.4/patch/uninstallpatch Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
List of missing patch IDs to act on, E.g. PatchIDs:[103980,103981]. Get the patch IDs from Get All Patches api
Provide a name for the Install Patch configuration,E.g. ConfigName:API install patch test1
Provide a description for the Install Patch configuration,E.g. ConfigDescription:API test
This will initiate deployment of the defined Install Patches Configuration to the specified targets in accordance with the provided criteria,E.g. actionToPerform:Deploy/ DeployImmediately/ Draft,Deploy : The deployment will initiate upon the agent's contact with the server,DeployImmediately : Deployed instantly without waiting for agent contact,Draft : Save the configuration as a draft.
ID of the deployment policy to apply. This parameter is mandatory. Get the template_id from Get Deployment Policies api
curl --request POST \
--url https://appdomains/api/1.4/patch/uninstallpatch \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{}' {
"PatchIDs": [
27170
],
"ConfigName": "API install patch test1",
"ConfigDescription": "API test",
"actionToPerform": "Deploy",
"DeploymentPolicyTemplateID": "1"
}
Value: uninstallpatch
Uninstall result object
API version: 1.4
Operation status: success
Error code: PATCH_INSTALL_FAILED_CODE for install failures, PATCH_UNINSTALL_FAILED_CODE for uninstall failures
Error type: PATCH_INSTALL_FAILED or PATCH_UNINSTALL_FAILED
Detailed failure reason: invalid targets, mixed platforms, patches already installed, no missing patches, insufficient permissions, or invalid configuration
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": "uninstallpatch",
"message_response": {
"uninstallpatch": {}
},
"message_version": "1.4",
"status": "success"
}
No patch IDs specified for uninstall
{
"error_code": "PATCH_UNINSTALL_FAILED_CODE",
"error": "PATCH_UNINSTALL_FAILED",
"error_description": "No Patches Specified"
}
Patches span multiple platform types
{
"error_code": "PATCH_INSTALL_FAILED_CODE",
"error": "PATCH_INSTALL_FAILED",
"error_description": "Specified Patches are not of the same platform/type"
}
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.