Fetches deployment details for a specific custom group Retrieves all deployment configurations associated with a custom group including per-deployment status counts for installed, failed, and pending targets.
Request URL https://{server-hostname}:8383/dcapi/swDeployment/cgDeployments
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
--url https://appdomain/dcapi/swDeployment/cgDeployments \
--header 'Accept: application/cgDeployments.v1+json' \
--header 'Authorization: d92d4xxxxxxxxxxxxx15f52'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/swDeployment/cgDeployments"))
.header("Accept", "application/cgDeployments.v1+json")
.header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("appdomain")
headers = {
'Accept': "application/cgDeployments.v1+json",
'Authorization': " d92d4xxxxxxxxxxxxx15f52"
}
conn.request("GET", "/dcapi/swDeployment/cgDeployments", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
headersMap = Map();
headersMap.put("Accept", "application/cgDeployments.v1+json");
response = invokeUrl
[
url: "https://appDomain/dcapi/swDeployment/cgDeployments"
type: GET
headers: headersMap
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("Accept", "application/cgDeployments.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/swDeployment/cgDeployments' -Method GET -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes customGroupId long
Resource ID of the custom group
deploymentDetails JSON Array
Array of deployment configurations
Show Sub-Attributes JSON Object
Show Sub-Attributes collectionId long
Collection ID of the deployment configuration
packageName string
Name of the deployed software package
status string
Deployment status for the group
totalTargets integer
Total number of target resources
installedCount integer
Number of successful installations
failedCount integer
Number of failed installations
yetToInstallCount integer
Number of pending installations
- HTTP code 500 Response Body - application/json JSON Object
Hide Sub-Attributes errorCode string
INTERNAL_ERROR for publish/modify failures, SW_INTERNAL_ERROR for SSP configuration errors
errorMessage string
Internal server error with details about the SSP publish or group operation failure
Possible Response Codes 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 {
"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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.