Initiate computer removal from Scope of Management

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 a computer removal request from the Scope of Management.

Request URL

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

Scope

DesktopCentralCloud.SOM.DELETECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/computerIdsToDelete.v1+jsonapplication/computerIdsToDelete.v1+jsonCopied!
AcceptstringMandatory
application/somComputerDeletedStatus.v1+jsonapplication/somComputerDeletedStatus.v1+jsonCopied!

- Request Body

application/json
JSON object
Hide Sub-Attributes
computerIDsarrayOptional

Array of computer resource IDs to perform the operation, get computer IDs from the response of the Computers API, under the resource_id field.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request DELETE \
  --url https://appdomain/dcapi/som/computers/actionRequest/remove \
  --header 'Accept: application/somComputerDeletedStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/computerIdsToDelete.v1+json' \
  --data '{}'
Show full

Sample Request Body

Remove computers from SoM

Copied!
  {
    "computerIDs": [
      "5001",
      "5002"
    ]
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object
Hide Sub-Attributes
statusboolean

Indicates whether the computer removal request was accepted and the delayed action was successfully queued

actionRequestIDstring

Unique tracking identifier for this removal action request. Use this ID to poll progress via removeStatus

messagestring

Descriptive message providing additional context about the removal result. Present when an error occurs or additional information is needed

- 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 HTTP Status Codes

200HTTP code
400HTTP code
412HTTP code

Sample Response: HTTP 200

Removal initiated

Copied!
  {
    "actionRequestID": "AR-REM-1712567890789",
    "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.