Retrieves the complete configuration details of the specified system tools task

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

Returns the full configuration details of the specified system tools collection, including all component tool settings (Check Disk, Defragmenter, Disk Cleanup, Task Scheduler), target settings, and schedule information.

Request URL

https://{server-hostname}:8383/dcapi/tools/systemTools/{collectionId}

Scope

Tools.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

collectionIdstringMandatory

The unique identifier of the system tools collection

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/tools/systemTools/{collectionId} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

System tools collection task unique identifier

labelstring

User-defined task label

descriptionstring

Task description

deployActionstring

Deployment action: Deploy

rebootClientComputersstring

Reboot flag: 0=No reboot, 1=Reboot after execution

targetDetailsJSON Object

Target configuration object with targetType, targetValue, and envType

Show Sub-Attributes
configDetailsarray

Array of tool configuration objects containing toolDetails

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "deployAction": "Deploy",
    "configDetails": [
      {
        "toolDetails": {
          "temporaryFiles": true,
          "internetCacheFiles": true,
          "recycleBin": true
        }
      }
    ],
    "description": "Cleans up temp files and recycle bin",
    "label": "Weekly Disk Cleanup",
    "collectionId": 12,
    "targetDetails": {
      "envType": 0,
      "targetValue": "Engineering",
      "targetType": "CustomGroup"
    },
    "rebootClientComputers": "0"
  }
                
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.