Force Stop Inprogress Deployment 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://{server-hostname}:8383/emsapi/osdeployer/deployments/{deploymentId}/forcestop
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers - Path Parameters deploymentId string Mandatory
ID of the OS Deployer Deployment
Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
--url https://appdomain/emsapi/osdeployer/deployments/{deploymentId}/forcestop \
--header 'Accept: application/deploymentStoppedStatus.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/emsapi/osdeployer/deployments/{deploymentId}/forcestop"))
.header("Accept", "application/deploymentStoppedStatus.v1+json")
.header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
.method("PUT", 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/deploymentStoppedStatus.v1+json",
'Authorization': " d92d4xxxxxxxxxxxxx15f52"
}
conn.request("PUT", "/emsapi/osdeployer/deployments/{deploymentId}/forcestop", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
headersMap = Map();
headersMap.put("Accept", "application/deploymentStoppedStatus.v1+json");
response = invokeUrl
[
url: "https://appDomain/emsapi/osdeployer/deployments/{deploymentId}/forcestop"
type: PUT
headers: headersMap
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("Accept", "application/deploymentStoppedStatus.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/emsapi/osdeployer/deployments/{deploymentId}/forcestop' -Method PUT -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/deploymentStoppedStatus.v1+json JSON Object
Hide Sub-Attributes isDeploymentStopped boolean
True if the deployment was successfully force-stopped.
Possible Response Codes 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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.