Initiate agent uninstallation on computers

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

Initiates an agent uninstallation request on one or more.

Request URL

https://{serverurl}/dcapi/som/computers/actionRequest/unInstallAgent

Scope

DesktopCentralCloud.SOM.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/somComputerIDsToUninstallAgent.v1+jsonapplication/somComputerIDsToUninstallAgent.v1+jsonCopied!
AcceptstringMandatory
application/somComputerAgentUninstallStatus.v1+jsonapplication/somComputerAgentUninstallStatus.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
computerIDsJSON ArrayMandatory

Array of computer resource IDs to perform the uninstallation on (maximum 1000 per request)

Show Sub-Attributes
string
actionFeedbackstringOptional

Optional administrator-provided reason or feedback explaining why this action is being performed (max 500 characters)

keepAssetPostbooleanOptional

When SDP is integrated whether to keep the asset data in SDP

removeMDMProfilebooleanOptional

When set to true, the MDM (Mobile Device Management) profile is also removed from the computer along with the agent

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/som/computers/actionRequest/unInstallAgent \
  --header 'Accept: application/somComputerAgentUninstallStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/somComputerIDsToUninstallAgent.v1+json' \
  --data '{"computerIDs":["3001","3002","3003"]}'

Sample Request Body

Uninstall agent from multiple computers

Copied!
  {
    "removeMDMProfile": true,
    "computerIDs": [
      "3001",
      "3002",
      "3003"
    ],
    "keepAssetPost": false,
    "actionFeedback": "Decommissioning old workstations"
  }
                
Show full

Response Parameters

- HTTP code 202

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

Array of resource IDs originally submitted in the agent uninstallation request

agentAvailableComputersarray

Array of resource IDs for computers where the agent is currently installed and available for uninstallation

statusboolean

Indicates whether the agent uninstallation request was accepted and the delayed action was successfully queued

actionRequestIDstring

Unique tracking identifier for this uninstallation action request.

- HTTP code 400

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

HTTP status code (400)

errorCodestring

API-specific error code identifying the validation failure

messagestring

Error message describing the validation failure

- HTTP code 412

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

HTTP status code (412)

errorCodestring

Precondition failed error code identifying the business logic violation

messagestring

Error message describing the precondition failed while processing request

Possible Response Codes

202HTTP code
400HTTP code
412HTTP code

Sample Response: HTTP 202

Uninstall request initiated

Copied!
  {
    "agentAvailableComputers": [
      3001,
      3002
    ],
    "requestedComputers": [
      3001,
      3002,
      3003
    ],
    "actionRequestID": "AR-UNINST-1712567890456",
    "status": true
  }
                
Show full

Sample Response: HTTP 400

Missing or empty computerIDs in request

Copied!
  {
    "errorCode": "20006",
    "message": "Resource IDs are not present in the request",
    "statusCode": 400
  }
                
Show full

Sample Response: HTTP 412

Non-admin user cannot access the requested computers

Copied!
  {
    "errorCode": "20005",
    "message": "Selected computers are not accessible",
    "statusCode": 412
  }
                
Show full

Some computers are not managed by the server

Copied!
  {
    "errorCode": "30007",
    "message": "All resources are not managed computers",
    "statusCode": 412
  }
                
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.