Updates the configuration and redeploys the specified system tools task

Updates the configuration of the specified system tools collection task, including tool selection, targets, and schedule settings. Re-deploys the modified task if it was already active.

Endpoints

put /dcapi/tools/systemTools/{collectionId}

Copy full URL

Request URL

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

Scope

Tools.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/collectionPersistStatus.v1+jsonCopied!

Content-TypestringMandatory

application/collectionDetails.v1+jsonCopied!

- Path Parameters

collectionIdstringMandatory

The unique identifier of the system tools collection

- 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 PUT \
  --url https://appdomain/dcapi/tools/systemTools/{collectionId} \
  --header 'Accept: application/collectionPersistStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/collectionDetails.v1+json' \
  --data '{"deployAction":"Deploy","configDetails":[{"toolDetails":{"temporaryFiles":true,"recycleBin":true}}],"description":"Updated task for cleaning temp files","label":"Updated Weekly Cleanup","targetDetails":{"envType":0,"targetValue":"Engineering","targetType":"CustomGroup"},"rebootClientComputers":"0"}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/dcapi/tools/systemTools/{collectionId}"))
        .header("Content-Type", "application/collectionDetails.v1+json")
        .header("Accept", "application/collectionPersistStatus.v1+json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"deployAction\":\"Deploy\",\"configDetails\":[{\"toolDetails\":{\"temporaryFiles\":true,\"recycleBin\":true}}],\"description\":\"Updated task for cleaning temp files\",\"label\":\"Updated Weekly Cleanup\",\"targetDetails\":{\"envType\":0,\"targetValue\":\"Engineering\",\"targetType\":\"CustomGroup\"},\"rebootClientComputers\":\"0\"}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"deployAction\":\"Deploy\",\"configDetails\":[{\"toolDetails\":{\"temporaryFiles\":true,\"recycleBin\":true}}],\"description\":\"Updated task for cleaning temp files\",\"label\":\"Updated Weekly Cleanup\",\"targetDetails\":{\"envType\":0,\"targetValue\":\"Engineering\",\"targetType\":\"CustomGroup\"},\"rebootClientComputers\":\"0\"}"

headers = {
    'Content-Type': "application/collectionDetails.v1+json",
    'Accept': "application/collectionPersistStatus.v1+json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/dcapi/tools/systemTools/{collectionId}", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/collectionPersistStatus.v1+json");
    headersMap.put("Content-Type", "application/collectionDetails.v1+json");

    data=Map();
    data.put("label","value");
    data.put("description","value");
    data.put("deployAction","value");
    data.put("rebootClientComputers","value");
    data_targetDetails=Map();
    data_targetDetails_allTargets=List();
    data_targetDetails_allTargets_item1=Map();
    data_targetDetails_allTargets_item1_singleTargetComponent=List();
    data_targetDetails_allTargets_item1_singleTargetComponent_item1=Map();
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow=Map();
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowProperties=Map();
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowProperties.put("isMainTarget",true);
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowProperties.put("targetType","1");
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowProperties.put("isExclude",true);
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow.put("rowProperties",data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowProperties);
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues=List();
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues_item1=Map();
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues_item1.put("targetDisplayText","value");
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues_item1.put("enteredValue","value");
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues_item1.put("order","1");
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues_item1.put("idValue","value");
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues_item1.put("isTargetValid",true);
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues_item1.put("isTargetRemoved","value");
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues_item1.put("cgType","1");
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues_item1.put("excludeChild","value");
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues_item1.put("canonicalPath","value");
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues_item1.put("domain","value");
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues_item1.put("isTargetComputable",true);
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues.add(data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues_item1);
    data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow.put("rowValues",data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow_rowValues);
    data_targetDetails_allTargets_item1_singleTargetComponent_item1.put("singleTargetRow",data_targetDetails_allTargets_item1_singleTargetComponent_item1_singleTargetRow);
    data_targetDetails_allTargets_item1_singleTargetComponent.add(data_targetDetails_allTargets_item1_singleTargetComponent_item1);
    data_targetDetails_allTargets_item1.put("singleTargetComponent",data_targetDetails_allTargets_item1_singleTargetComponent);
    data_targetDetails_allTargets_item1_mainTarget=Map();
    data_targetDetails_allTargets_item1_mainTarget.put("targetName","value");
    data_targetDetails_allTargets_item1_mainTarget.put("targetType","value");
    data_targetDetails_allTargets_item1_mainTarget_selectedValues=List();
    data_targetDetails_allTargets_item1_mainTarget_selectedValues_item1=Map();
    data_targetDetails_allTargets_item1_mainTarget_selectedValues_item1.put("label","value");
    data_targetDetails_allTargets_item1_mainTarget_selectedValues_item1.put("idValue","value");
    data_targetDetails_allTargets_item1_mainTarget_selectedValues_item1.put("excludeChild","value");
    data_targetDetails_allTargets_item1_mainTarget_selectedValues_item1.put("canonicalPath","value");
    data_targetDetails_allTargets_item1_mainTarget_selectedValues_item1.put("domain","value");
    data_targetDetails_allTargets_item1_mainTarget_selectedValues_item1.put("isTargetComputable",true);
    data_targetDetails_allTargets_item1_mainTarget_selectedValues_item1.put("cgType","1");
    data_targetDetails_allTargets_item1_mainTarget_selectedValues_item1.put("isTargetRemoved","value");
    data_targetDetails_allTargets_item1_mainTarget_selectedValues.add(data_targetDetails_allTargets_item1_mainTarget_selectedValues_item1);
    data_targetDetails_allTargets_item1_mainTarget.put("selectedValues",data_targetDetails_allTargets_item1_mainTarget_selectedValues);
    data_targetDetails_allTargets_item1.put("mainTarget",data_targetDetails_allTargets_item1_mainTarget);
    data_targetDetails_allTargets_item1_userRefineTarget=Map();
    data_targetDetails_allTargets_item1_userRefineTarget_includeTargets=List();
    data_targetDetails_allTargets_item1_userRefineTarget_includeTargets_item1=Map();
    data_targetDetails_allTargets_item1_userRefineTarget_includeTargets_item1.put("targetType","value");
    data_targetDetails_allTargets_item1_userRefineTarget_includeTargets_item1_selectedValues=List();
    data_targetDetails_allTargets_item1_userRefineTarget_includeTargets_item1_selectedValues_item1=Map();
    data_targetDetails_allTargets_item1_userRefineTarget_includeTargets_item1_selectedValues_item1.put("idValue","value");
    data_targetDetails_allTargets_item1_userRefineTarget_includeTargets_item1_selectedValues_item1.put("label","value");
    data_targetDetails_allTargets_item1_userRefineTarget_includeTargets_item1_selectedValues_item1.put("domain","value");
    data_targetDetails_allTargets_item1_userRefineTarget_includeTargets_item1_selectedValues_item1.put("isTargetRemoved","value");
    data_targetDetails_allTargets_item1_userRefineTarget_includeTargets_item1_selectedValues.add(data_targetDetails_allTargets_item1_userRefineTarget_includeTargets_item1_selectedValues_item1);
    data_targetDetails_allTargets_item1_userRefineTarget_includeTargets_item1.put("selectedValues",data_targetDetails_allTargets_item1_userRefineTarget_includeTargets_item1_selectedValues);
    data_targetDetails_allTargets_item1_userRefineTarget_includeTargets.add(data_targetDetails_allTargets_item1_userRefineTarget_includeTargets_item1);
    data_targetDetails_allTargets_item1_userRefineTarget.put("includeTargets",data_targetDetails_allTargets_item1_userRefineTarget_includeTargets);
    data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets=List();
    data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets_item1=Map();
    data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets_item1.put("targetType","value");
    data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets_item1_selectedValues=List();
    data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets_item1_selectedValues_item1=Map();
    data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets_item1_selectedValues_item1.put("idValue","value");
    data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets_item1_selectedValues_item1.put("label","value");
    data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets_item1_selectedValues_item1.put("domain","value");
    data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets_item1_selectedValues_item1.put("isTargetRemoved","value");
    data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets_item1_selectedValues.add(data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets_item1_selectedValues_item1);
    data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets_item1.put("selectedValues",data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets_item1_selectedValues);
    data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets.add(data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets_item1);
    data_targetDetails_allTargets_item1_userRefineTarget.put("excludeTargets",data_targetDetails_allTargets_item1_userRefineTarget_excludeTargets);
    data_targetDetails_allTargets_item1.put("userRefineTarget",data_targetDetails_allTargets_item1_userRefineTarget);
    data_targetDetails_allTargets_item1_computerRefineTarget=Map();
    data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets=List();
    data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets_item1=Map();
    data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets_item1.put("targetType","value");
    data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets_item1_selectedValues=List();
    data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets_item1_selectedValues_item1=Map();
    data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets_item1_selectedValues_item1.put("idValue","value");
    data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets_item1_selectedValues_item1.put("label","value");
    data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets_item1_selectedValues_item1.put("domain","value");
    data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets_item1_selectedValues_item1.put("isTargetRemoved","value");
    data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets_item1_selectedValues.add(data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets_item1_selectedValues_item1);
    data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets_item1.put("selectedValues",data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets_item1_selectedValues);
    data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets.add(data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets_item1);
    data_targetDetails_allTargets_item1_computerRefineTarget.put("includeTargets",data_targetDetails_allTargets_item1_computerRefineTarget_includeTargets);
    data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets=List();
    data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets_item1=Map();
    data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets_item1.put("targetType","value");
    data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets_item1_selectedValues=List();
    data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets_item1_selectedValues_item1=Map();
    data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets_item1_selectedValues_item1.put("idValue","value");
    data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets_item1_selectedValues_item1.put("label","value");
    data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets_item1_selectedValues_item1.put("domain","value");
    data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets_item1_selectedValues_item1.put("isTargetRemoved","value");
    data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets_item1_selectedValues.add(data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets_item1_selectedValues_item1);
    data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets_item1.put("selectedValues",data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets_item1_selectedValues);
    data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets.add(data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets_item1);
    data_targetDetails_allTargets_item1_computerRefineTarget.put("excludeTargets",data_targetDetails_allTargets_item1_computerRefineTarget_excludeTargets);
    data_targetDetails_allTargets_item1.put("computerRefineTarget",data_targetDetails_allTargets_item1_computerRefineTarget);
    data_targetDetails_allTargets_item1.put("isExcludeServersEnabled",true);
    data_targetDetails_allTargets.add(data_targetDetails_allTargets_item1);
    data_targetDetails.put("allTargets",data_targetDetails_allTargets);
    data_targetDetails.put("isTechMapWithCG",true);
    data_targetDetails.put("isTechMapWithRO",true);
    data_targetDetails.put("isUserConfigBasedOnROorWG","value");
    data.put("targetDetails",data_targetDetails);
    data_configDetails=List();
    data_configDetails_item1=Map();
    data_configDetails_item1.put("configName","value");
    data_configDetails.add(data_configDetails_item1);
    data.put("configDetails",data_configDetails);

    response = invokeUrl
    [
        url: "https://appDomain/dcapi/tools/systemTools/{collectionId}"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/collectionDetails.v1+json")
$headers.Add("Accept", "application/collectionPersistStatus.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/tools/systemTools/{collectionId}' -Method PUT -Headers $headers -ContentType 'application/collectionDetails.v1+json' -Body '{"deployAction":"Deploy","configDetails":[{"toolDetails":{"temporaryFiles":true,"recycleBin":true}}],"description":"Updated task for cleaning temp files","label":"Updated Weekly Cleanup","targetDetails":{"envType":0,"targetValue":"Engineering","targetType":"CustomGroup"},"rebootClientComputers":"0"}'

Sample Request Body

Copied!

  {
    "deployAction": "Deploy",
    "configDetails": [
      {
        "toolDetails": {
          "temporaryFiles": true,
          "recycleBin": true
        }
      }
    ],
    "description": "Updated task for cleaning temp files",
    "label": "Updated Weekly 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": 12,
    "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.