Stop a running deployment task

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

Signals all in-progress deployments under this task to stop. Already-completed targets are unaffected.

Request URL

https://{server-hostname}:8383/emsapi/osdeployer/tasks/{taskId}/stop

Scope

OSDTask.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

taskIdstringMandatory

ID of the OS Deployment task

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/emsapi/osdeployer/tasks/{taskId}/stop \
  --header 'Accept: application/deploymentTaskStoppedStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/deploymentTaskStoppedStatus.v1+json
JSON Object
Hide Sub-Attributes
isTaskStoppedboolean

True if the task was successfully stopped.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Task has transitioned to STOPPED

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