Retrieves tool deployment details for a specific custom group

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 list of tool deployment configurations (System Tools, Shutdown, WOL, Announcement) that target the specified custom group, identified by the 'customGroupId' query parameter.

Endpoints

Request URL

https://{serverurl}/dcapi/tools/cgDeployments

Scope

DesktopCentralCloud.Tools.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

customGroupIdlongMandatory

Unique ID of the custom group to retrieve tool deployment configurations for. Required

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomains/dcapi/tools/cgDeployments?customGroupId=SOME_INTEGER_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Array of deployment objects with deploymentType, taskName, taskId, and status for each tool targeting the specified custom group

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "deployments": [
      {
        "deploymentType": "SystemTools",
        "taskName": "Weekly Cleanup",
        "taskId": 12,
        "status": "Active"
      },
      {
        "deploymentType": "Shutdown",
        "taskName": "Nightly Shutdown",
        "taskId": 5,
        "status": "Active"
      }
    ]
  }
                
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.