Suspend an APD Task Deprecating soon

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

Suspending a APD task.

This API endpoint is deprecating soon

Request URL

https://{server-hostname}:8383/api/1.4/patch/suspendAPDTask

Scope

PatchMgmt.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

- Request Body

application/json
JSON object
Hide Sub-Attributes
tasknamestringMandatory

Name of the APD task to suspend

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/api/1.4/patch/suspendAPDTask \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"taskname":"windows create task"}'
Show full

Sample Request Body

Suspend an APD Task by name

Copied!
  {
    "taskname": "windows create task"
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON object
Hide Sub-Attributes
message_typestring

Action identifier: suspendAPDTask

message_responseJSON object

Suspend result payload

Show Sub-Attributes
suspendapdtaskJSON object

Suspend action result

Show Sub-Attributes
statusstring

Action result message (e.g., task has been deleted/resumed/suspended/modified successfully)

message_versionstring

API version: 1.4

statusstring

Overall operation status: success

- HTTP code 400

Response Body - application/json
JSON object
Hide Sub-Attributes
error_codestring

Error code: APD_TASK_NOT_FOUND for task name mismatch, APD_ACTION_FAILED for action failures

errorstring

Error type: APD_TASK_NOT_FOUND or APD_ACTION_FAILED

error_descriptionstring

Detailed failure reason: task not found, task already in target state, or insufficient permissions

Possible Response Codes

200HTTP code
400HTTP code

Sample Response: HTTP 200

APD task suspended successfully

Copied!
  {
    "message_type": "suspendAPDTask",
    "message_response": {
      "suspendapdtask": {
        "status": "task has been suspended successfully"
      }
    },
    "message_version": "1.4",
    "status": "success"
  }
                
Show full

Sample Response: HTTP 400

APD task with the given name does not exist

Copied!
  {
    "error_description": "The specified APD task was not found",
    "error_code": "APD_TASK_NOT_FOUND",
    "error": "APD_TASK_NOT_FOUND"
  }
                
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.