Creates and deploys a new system tools task targeting specified 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

Creates and deploys a new system tools collection task. Accepts a JSON body specifying the task label, description, tools to run (Check Disk, Defragmenter, Disk Cleanup, Task Scheduler), target computers or groups, and schedule configuration.

Request URL

https://{serverurl}/dcapi/tools/systemTools/tasks/deploy

Scope

DesktopCentralCloud.Tools.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/collectionDeployStatus.v1+jsonapplication/collectionDeployStatus.v1+jsonCopied!
Content-TypestringMandatory
application/collectionDetails.v1+jsonapplication/collectionDetails.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
labelstringMandatory
descriptionstringMandatory
deployActionstringOptional
rebootClientComputersstringOptional
targetDetailsJSON ObjectOptional
Show Sub-Attributes
allTargetsJSON ArrayOptional
Show Sub-Attributes
JSON Object
Show Sub-Attributes
singleTargetComponentJSON ArrayOptional
Show Sub-Attributes
JSON Object
Show Sub-Attributes
singleTargetRowJSON ObjectOptional
Show Sub-Attributes
rowPropertiesJSON ObjectOptional
Show Sub-Attributes
isMainTargetbooleanOptional
targetTypeintegerOptional
isExcludebooleanOptional
rowValuesJSON ArrayOptional
Show Sub-Attributes
JSON Object
Show Sub-Attributes
targetDisplayTextstringOptional
enteredValuestringOptional
orderintegerOptional
idValuestringOptional
isTargetValidbooleanOptional
isTargetRemovedstringOptional
cgTypeintegerOptional
excludeChildstringOptional
canonicalPathstringOptional
domainstringOptional
isTargetComputablebooleanOptional
mainTargetJSON ObjectOptional
Show Sub-Attributes
targetNamestringOptional
targetTypestringOptional
selectedValuesJSON ArrayOptional
Show Sub-Attributes
JSON Object
Show Sub-Attributes
labelstringOptional
idValuestringOptional
excludeChildstringOptional
canonicalPathstringOptional
domainstringOptional
isTargetComputablebooleanOptional
cgTypeintegerOptional
isTargetRemovedstringOptional
userRefineTargetJSON ObjectOptional
Show Sub-Attributes
includeTargetsJSON ArrayOptional

Refine selections that further restrict the main target — only resources matching these entries are included.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
targetTypestringOptional

Numeric target-type code returned as a string. Common values: 1=Domain, 2=Remote Office, 5=Custom Group, 7=User, 8=Computer.

selectedValuesJSON ArrayOptional

Array of the selected target entities (Remote Offices, Computers, Users, etc.) belonging to this targetType.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
idValuestringOptional

Unique identifier of the target entity (resource ID, Remote Office ID, Custom Group ID, Domain ID, etc.) returned as a string.

labelstringOptional

Display name of the target entity.

domainstringOptional

Active Directory domain or Workgroup name of the entity. Returned only for Computer or User entries.

isTargetRemovedstringOptional

'true' if the target entity no longer exists in the customer's environment but is still referenced by the configuration; otherwise 'false'.

excludeTargetsJSON ArrayOptional

Refine selections that exclude resources from the main target. Returned only when the configuration explicitly excludes specific resources.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
targetTypestringOptional

Numeric target-type code returned as a string. Common values: 1=Domain, 2=Remote Office, 5=Custom Group, 7=User, 8=Computer.

selectedValuesJSON ArrayOptional

Array of the selected target entities (Remote Offices, Computers, Users, etc.) belonging to this targetType.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
idValuestringOptional

Unique identifier of the target entity (resource ID, Remote Office ID, Custom Group ID, Domain ID, etc.) returned as a string.

labelstringOptional

Display name of the target entity.

domainstringOptional

Active Directory domain or Workgroup name of the entity. Returned only for Computer or User entries.

isTargetRemovedstringOptional

'true' if the target entity no longer exists in the customer's environment but is still referenced by the configuration; otherwise 'false'.

computerRefineTargetJSON ObjectOptional
Show Sub-Attributes
includeTargetsJSON ArrayOptional

Refine selections that further restrict the main target — only resources matching these entries are included.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
targetTypestringOptional

Numeric target-type code returned as a string. Common values: 1=Domain, 2=Remote Office, 5=Custom Group, 7=User, 8=Computer.

selectedValuesJSON ArrayOptional

Array of the selected target entities (Remote Offices, Computers, Users, etc.) belonging to this targetType.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
idValuestringOptional

Unique identifier of the target entity (resource ID, Remote Office ID, Custom Group ID, Domain ID, etc.) returned as a string.

labelstringOptional

Display name of the target entity.

domainstringOptional

Active Directory domain or Workgroup name of the entity. Returned only for Computer or User entries.

isTargetRemovedstringOptional

'true' if the target entity no longer exists in the customer's environment but is still referenced by the configuration; otherwise 'false'.

excludeTargetsJSON ArrayOptional

Refine selections that exclude resources from the main target. Returned only when the configuration explicitly excludes specific resources.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
targetTypestringOptional

Numeric target-type code returned as a string. Common values: 1=Domain, 2=Remote Office, 5=Custom Group, 7=User, 8=Computer.

selectedValuesJSON ArrayOptional

Array of the selected target entities (Remote Offices, Computers, Users, etc.) belonging to this targetType.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
idValuestringOptional

Unique identifier of the target entity (resource ID, Remote Office ID, Custom Group ID, Domain ID, etc.) returned as a string.

labelstringOptional

Display name of the target entity.

domainstringOptional

Active Directory domain or Workgroup name of the entity. Returned only for Computer or User entries.

isTargetRemovedstringOptional

'true' if the target entity no longer exists in the customer's environment but is still referenced by the configuration; otherwise 'false'.

isExcludeServersEnabledbooleanOptional
isTechMapWithCGbooleanOptional
isTechMapWithRObooleanOptional
isUserConfigBasedOnROorWGstringOptional
configDetailsOptional
Hide Sub-Attributes
oneOf
JSON Object
Show Sub-Attributes
configNamestringMandatory
JSON Object
Show Sub-Attributes
configNamestringMandatory
JSON Object
Show Sub-Attributes
configNamestringMandatory
JSON Object
Show Sub-Attributes
configNamestringMandatory

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/tools/systemTools/tasks/deploy \
  --header 'Accept: application/collectionDeployStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/collectionDetails.v1+json' \
  --data '{"description":"Automate disk cleanup for Engineering team","label":"Weekly Disk Cleanup"}'

Sample Request Body

Copied!
  {
    "deployAction": "Deploy",
    "configDetails": [
      {
        "toolDetails": {
          "temporaryFiles": true,
          "internetCacheFiles": false,
          "recycleBin": true
        }
      }
    ],
    "description": "Automate disk cleanup for Engineering team",
    "label": "Weekly Disk Cleanup",
    "targetDetails": {
      "envType": 0,
      "targetValue": "Engineering",
      "targetType": "CustomGroup"
    },
    "rebootClientComputers": "0"
  }
                
Show full

Response Parameters

- HTTP code 200

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

Result of the create or update operation: success or failure

collectionIdlong

Unique identifier of the created or updated task collection

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "collectionId": 15,
    "status": "success"
  }
                
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.