Pause 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

Pauses a running deployment task; the remaining time is captured via the timeLeft query parameter so the task can resume from the same point.

Request URL

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

Scope

OSDTask.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/deploymentTaskPausedStatus.v1+jsonapplication/deploymentTaskPausedStatus.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}/pause \
  --header 'Accept: application/deploymentTaskPausedStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/deploymentTaskPausedStatus.v1+json
JSON Object
Hide Sub-Attributes
isTaskPausedboolean

True if the task was successfully paused.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Task paused with 300000 milliseconds (5 minutes) remaining

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