Force Stop Inprogress Deployment

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

Forces an in-progress deployment to terminate immediately, bypassing the graceful stop sequence. Use this when the standard stop endpoint fails to abort the deployment in a timely manner.

Request URL

https://{serverurl}/emsapi/osdeployer/deployments/{deploymentId}/forcestop

Scope

DesktopCentralCloud.OSDDeployment.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

deploymentIdstringMandatory

ID of the OS Deployer Deployment

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomains/emsapi/osdeployer/deployments/{deploymentId}/forcestop \
  --header 'Accept: application/deploymentStoppedStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/deploymentStoppedStatus.v1+json
JSON Object
Hide Sub-Attributes
isDeploymentStoppedboolean

True if the deployment was successfully force-stopped.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Deployment was force-stopped

Copied!
  {
    "isDeploymentStopped": true
  }
                
Show full

Duration: 1 minute | Threshold: 50 | 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.