# Creates and deploys a new system tools task targeting specified computers

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.

## Endpoint

`POST /dcapi/tools/systemTools/tasks/deploy`

## Request

### Request URL

`https://{server-hostname}:8383/dcapi/tools/systemTools/tasks/deploy`

### Scope

`Tools.UPDATE`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Accept** — `string` — **Mandatory**
  - `application/collectionDeployStatus.v1+json`
- **Content-Type** — `string` — **Mandatory**
  - `application/collectionDetails.v1+json`

#### Request Body

`application/json`

- `JSON Object`
  - **label** — `string` — **Mandatory**
  - **description** — `string` — **Mandatory**
  - **deployAction** — `string` — Optional
  - **rebootClientComputers** — `string` — Optional
  - **targetDetails** — `JSON Object` — Optional
  - **configDetails** — Optional
    - `oneOf`
      - `JSON Object`
      - `JSON Object`
      - `JSON Object`
      - `JSON Object`

### Sample Request

```curl
curl --request POST \
  --url https://appdomain/dcapi/tools/systemTools/tasks/deploy \
  --header 'Accept: application/collectionDeployStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/collectionDetails.v1+json' \
  --data '{"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"}'
```

### Sample Request Body

```json
{
  "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"
}
```

## Response

### Response Parameters

#### HTTP Code 200

Response Body — `application/json`

- `JSON Object`
  - **status** — `string`
    - Result of the create or update operation: success or failure
  - **collectionId** — `long`
    - Unique identifier of the created or updated task collection

### Possible Response Codes

- **200** — HTTP code

### Sample Response: HTTP 200

```json
{
  "collectionId": 15,
  "status": "success"
}
```

## API Rate Limit

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**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.