Uninstall Specific Patches

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Uninstalls specified patches from all applicable systems.

Request URL

https://{serverurl}/api/1.4/patch/uninstallpatch

Scope

DesktopCentralCloud.PatchMgmt.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

customeridlongOptional

- Request Body

application/json
JSON Object
Hide Sub-Attributes
PatchIDsarrayMandatory

Array of patch IDs to uninstall. Mandatory for uninstall.

ResourceIDsarrayOptional

Array of target resource IDs. If omitted, uninstalls from all applicable systems.

ConfigNamestringMandatory

Name for the uninstall patch configuration

ConfigDescriptionstringOptional

Description for the uninstall patch configuration

actionToPerformstringMandatory

Deployment action: Deploy, DeployImmediately, or Draft

DeploymentPolicyTemplateIDlongMandatory

Deployment policy template ID. Fetch from Get Deployment Policies

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/api/1.4/patch/uninstallpatch \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"PatchIDs":[27170],"ConfigName":"API uninstall patch test1","actionToPerform":"Deploy","DeploymentPolicyTemplateID":1}'

Sample Request Body

Uninstall patches from all applicable systems

Copied!
  {
    "PatchIDs": [
      27170
    ],
    "ConfigName": "API uninstall patch test1",
    "actionToPerform": "Deploy",
    "ConfigDescription": "API test",
    "DeploymentPolicyTemplateID": 1
  }
                
Show full

Uninstall patches from specific target systems

Copied!
  {
    "PatchIDs": [
      27170
    ],
    "ConfigName": "API uninstall patch test1",
    "ResourceIDs": [
      601,
      602
    ],
    "actionToPerform": "Deploy",
    "ConfigDescription": "API test",
    "DeploymentPolicyTemplateID": 1
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
message_typestring

Action identifier: uninstallpatch

message_responseJSON Object

Uninstall result payload

Show Sub-Attributes
uninstallpatchJSON Object

Empty object on success — uninstall initiated asynchronously

Show Sub-Attributes
message_versionstring

API version: 1.4

statusstring

Overall operation status: success

- HTTP code 400

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

Error code: PATCH_INSTALL_FAILED_CODE for install failures, PATCH_UNINSTALL_FAILED_CODE for uninstall failures

errorstring

Error type: PATCH_INSTALL_FAILED or PATCH_UNINSTALL_FAILED

error_descriptionstring

Detailed failure reason: invalid targets, mixed platforms, patches already installed, no missing patches, insufficient permissions, or invalid configuration

Possible Response Codes

200HTTP code
400HTTP code

Sample Response: HTTP 200

Uninstall deployment initiated

Copied!
  {
    "message_type": "uninstallpatch",
    "message_response": {
      "uninstallpatch": {}
    },
    "message_version": "1.4",
    "status": "success"
  }
                
Show full

Sample Response: HTTP 400

No patch IDs specified for uninstall

Copied!
  {
    "error_description": "No Patches Specified",
    "error_code": "PATCH_UNINSTALL_FAILED_CODE",
    "error": "PATCH_UNINSTALL_FAILED"
  }
                
Show full

Patches span multiple platform types

Copied!
  {
    "error_description": "Specified Patches are not of the same platform/type",
    "error_code": "PATCH_INSTALL_FAILED_CODE",
    "error": "PATCH_INSTALL_FAILED"
  }
                
Show full

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.