Create an APD Task

Creates a new Automated Patch Deployment (APD) task.

Endpoints

post /api/1.4/patch/createAPDTask

Copy full URL

Request URL

https://{serverurl}/api/1.4/patch/createAPDTask

Scope

DesktopCentralCloud.PatchMgmt.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

customeridlongOptional

- 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://appdomains/api/1.4/patch/createAPDTask \
  --header 'Authorization: Zoho-oauthtoken  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}}'

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://appdomains/api/1.4/patch/createAPDTask"))
        .header("content-type", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"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}}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

payload = "{\"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}}"

headers = {
    'content-type': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/api/1.4/patch/createAPDTask", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("settings","value");

    response = invokeUrl
    [
        url: "https://appDomains/api/1.4/patch/createAPDTask"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("content-type", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/api/1.4/patch/createAPDTask' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"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}}'

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.