Create an APD 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

Creates a new Automated Patch Deployment (APD) task.

Request URL

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

Scope

PatchMgmt.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

- Request Body

application/json
JSON object
Hide Sub-Attributes
settingsstringMandatory

APD task configuration object

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/api/1.4/patch/createAPDTask \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"settings":{"feature_packs":false,"platformFilter":["Windows"],"service_packs":false,"collections":[1,2,3],"definition_update":false,"severityFilter":["Critical","Important"],"description":"Automated patch deployment","thirdparty_update":true,"taskName":"My APD Task","non_security_update":false,"security_update":true,"rollups":false}}'
Show full

Sample Request Body

Create APD task with security and third-party updates

Copied!
  {
    "settings": {
      "feature_packs": false,
      "platformFilter": [
        "Windows"
      ],
      "service_packs": false,
      "collections": [
        1,
        2,
        3
      ],
      "definition_update": false,
      "severityFilter": [
        "Critical",
        "Important"
      ],
      "description": "Automated patch deployment",
      "thirdparty_update": true,
      "taskName": "My APD Task",
      "non_security_update": false,
      "security_update": true,
      "rollups": false
    }
  }
                
Show full

Response Parameters

- HTTP code 200

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

Value: createAPDTask

message_responseJSON object

Task creation result with status message

Show Sub-Attributes
message_versionstring

API version: 1.4

statusstring

Operation status: success

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

APD task created

Copied!
  {
    "message_type": "createAPDTask",
    "message_response": {
      "createapdtask": {
        "status": "windows create task  task created successfully"
      }
    },
    "message_version": "1.4",
    "status": "success"
  }
                
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.