Retrieve agent installation progress

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 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

SOM.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

Sample Request

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'

Response Parameters

- HTTP code 200

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

Whether agent installation is currently in progress

completedComputerCountstring

Number of computers where installation completed (success or fail)

totalComputerCountstring

Total number of computers targeted for installation

wanComputerCountstring

Number of WAN/remote computers in the install batch

installFailedCountstring

Number of computers where installation failed. Present only if failures exist

retryInstallFailedCountstring

Count of failed installations eligible for retry

isAgentInstallStoppedstring

Whether the agent install workflow was stopped by the user

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Installation in progress

Copied!
  {
    "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.