Uninstall Patch

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 Copied!

Scope

DesktopCentralCloud.PatchMgmt.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
PatchIDsarrayOptional

List of missing patch IDs to act on, E.g. PatchIDs:[103980,103981]. Get the patch IDs from Get All Patches api

ConfigNamestringOptional

Provide a name for the Install Patch configuration,E.g. ConfigName:API install patch test1

ConfigDescriptionstringOptional

Provide a description for the Install Patch configuration,E.g. ConfigDescription:API test

actionToPerformstringOptional

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.

DeploymentPolicyTemplateIDlongOptional

ID of the deployment policy to apply. This parameter is mandatory. Get the template_id from Get Deployment Policies api

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
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 '{}'

Sample Request Body

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

Response Parameters

- HTTP code 200

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

Value: uninstallpatch

message_responseobject

Uninstall result object

message_versionstring

API version: 1.4

statusstring

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

- HTTP code 401

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

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

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

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

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

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

errorMsgstring

Rate limit exceeded message with retry guidance

Sample Response: HTTP 200

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_code": "PATCH_UNINSTALL_FAILED_CODE",
    "error": "PATCH_UNINSTALL_FAILED",
    "error_description": "No Patches Specified"
  }
                
▼ Show full

Patches span multiple platform types

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

Sample Response: HTTP 401

Authentication credentials are missing, expired or invalid

Copied!
  {
    "error_code": "UAC_UNAUTHORIZED",
    "error_description": "dc.rest.authentication.unauthorized"
  }
                
▼ Show full

Sample Response: HTTP 403

Authenticated user lacks the required role or scope

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMessage": "You do not have sufficient privileges to perform this operation"
  }
                
▼ Show full

Sample Response: HTTP 429

API call threshold exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMessage": "API call limit exceeded. Retry after the lock period elapses"
  }
                
▼ 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.