Fetches 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

Retrieves all deployment configurations associated with a custom group including per-deployment status counts for installed, failed, and pending targets.

Request URL

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

Scope

DesktopCentralCloud.SWDeployment.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/cgDeployments.v1+jsonapplication/cgDeployments.v1+jsonCopied!

- Query Parameters

customGroupIdlongMandatory

Resource ID of the custom group. Obtain from the groupResourceId field in the response of the List SSP Publish Groups API.

Sample Request

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

Response Parameters

- HTTP code 200

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

Resource ID of the custom group

deploymentDetailsJSON Array

Array of deployment configurations

Show Sub-Attributes
JSON Object
Show Sub-Attributes
collectionIdlong

Collection ID of the deployment configuration

packageNamestring

Name of the deployed software package

statusstring

Deployment status for the group

totalTargetsinteger

Total number of target resources

installedCountinteger

Number of successful installations

failedCountinteger

Number of failed installations

yetToInstallCountinteger

Number of pending installations

- HTTP code 500

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

INTERNAL_ERROR for publish/modify failures, SW_INTERNAL_ERROR for SSP configuration errors

errorMessagestring

Internal server error with details about the SSP publish or group operation failure

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Group has active deployments

Copied!
  {
    "deploymentDetails": [
      {
        "failedCount": 5,
        "installedCount": 35,
        "packageName": "7-Zip 23.01",
        "totalTargets": 50,
        "collectionId": 5001,
        "status": "In Progress",
        "yetToInstallCount": 10
      }
    ],
    "customGroupId": 301
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "errorMessage": "Internal Server Error",
    "errorCode": "INTERNAL_ERROR"
  }
                
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.