Retrieve agent installation progress Retrieves the current status and progress of an agent installation operation including completed, total, and WAN computer counts.
Request URL https://{server-hostname}:8383/dcapi/som/computers/agentInstallStatus
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
--url https://appdomain/dcapi/som/computers/agentInstallStatus \
--header 'Accept: application/somComputerAgentInstallationStatus.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/som/computers/agentInstallStatus"))
.header("Accept", "application/somComputerAgentInstallationStatus.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/somComputerAgentInstallationStatus.v1+json",
'Authorization': " d92d4xxxxxxxxxxxxx15f52"
}
conn.request("GET", "/dcapi/som/computers/agentInstallStatus", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
headersMap = Map();
headersMap.put("Accept", "application/somComputerAgentInstallationStatus.v1+json");
response = invokeUrl
[
url: "https://appDomain/dcapi/som/computers/agentInstallStatus"
type: GET
headers: headersMap
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("Accept", "application/somComputerAgentInstallationStatus.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/som/computers/agentInstallStatus' -Method GET -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes installInProgress boolean
Whether agent installation is currently in progress
completedComputerCount string
Number of computers where installation completed (success or fail)
totalComputerCount string
Total number of computers targeted for installation
wanComputerCount string
Number of WAN/remote computers in the install batch
installFailedCount string
Number of computers where installation failed. Present only if failures exist
retryInstallFailedCount string
Count of failed installations eligible for retry
isAgentInstallStopped string
Whether the agent install workflow was stopped by the user
Possible Response Codes Sample Response: HTTP 200 {
"totalComputerCount": 10,
"wanComputerCount": 3,
"completedComputerCount": 5,
"installInProgress": true
}
▼ Show full
Installation completed with failures
Copied!
{
"totalComputerCount": 10,
"wanComputerCount": 3,
"completedComputerCount": 10,
"installFailedCount": 2,
"retryInstallFailedCount": "1",
"installInProgress": false
}
▼ 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.