Install Specific Patches in Specific Systems

Endpoints

post /api/1.4/patch/installpatch

Copy full URL

Request URL

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

Scope

DesktopCentralCloud.PatchMgmt.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

customeridlongOptional

- Request Body

application/json

JSON Object

Hide Sub-Attributes

isOnlyApprovedstringOptional

(Optional): true = deploy only approved patches, false = deploy all

ResourceIDsJSON ArrayOptional

Enter the list of resources with missing patches in your network,E.g. ResourceIDs:[601,602]

Show Sub-Attributes

string

PatchIDsJSON ArrayOptional

Enter the list of missing patches detected in your network,E.g. PatchIDs:[103980,103981,103980]

Show Sub-Attributes

string

ConfigNamestringOptional

Provide a name for the Install Patch configuration,E.g. ConfigName:API install patch test1

ConfigDescriptionstringOptional

Provide a description for the Install Patch configuration,E.g. ConfigDescription:API test

actionToPerformstringOptional

This will initiate deployment of the defined Install Patches Configuration to the specified targets in accordance with the provided criteria,E.g. actionToPerform:Deploy/ Deploy Immediately/ Draft,Deploy : The deployment will initiate upon the agent's contact with the server,Deploy Immediately : Deployed instantly without waiting for agent contact,Draft : Save the configuration as a draft.

DeploymentPolicyTemplateIDlongOptional

Retrieve the Deployment Policy ID by executing the following API, /api/1.4/patch/deploymentpolicies and and provide the value of the template_id param value.

installaftertimestringOptional

Specify the date and time for patch installation to begin. Patches will be installed based on the selected options after the scheduled time. Use the format: yyyy-MM-dd HH:MM.

expirytimestringOptional

This configuration will not be applied after the specified time. Use the format yyyy-MM-dd HH:MM.

deploymentTypestringOptional

Provide the preferred deployment option here. Accepted values : 0/1/2,E.g. deploymentType: 0/1/2,0 - Deploy only (default)This option enables you to deploy the selected patches to the targeted endpoints according to the relevant deployment policies,1 - Publish in Self Service Portal only (DeploymentPolicyTemplateID will be ignored),This option enables administrators to publish the selected patches to the Self Service Portal. End users and server owners can then initiate the installation process at their convenience,2 - This option incorporates both deployment and publication actions.Note: If deploymentType is set to 0 or 1, then the DeploymentPolicyTemplateID field is mandatory.

deadlineTimelongOptional

Specify the time, in milliseconds, for force deploying the patches to unpatched systems in your network,E.g. deadlineTime: 1691393760 (Time in milliseconds),Note : Max of 1 year is supported

forceRebootOptionstringOptional

Depending on the selected Deployment Policy, you can choose to enable Force Reboot either within or outside the deployment window. Accepted Values : 0/1/2,E.g. forceRebootOption:0/1/2,0 - Not configured,1 - Within the deployment/reboot window,2 - Outside the deployment/reboot window.

resourceNamesJSON ArrayOptional

Specify the required list of resource names for deployment ex:resourceNames:[win-1422,wind-144d]

Show Sub-Attributes

string

customGroupsJSON ArrayOptional

Specify the required list of Custom Group names for deployment ex:customGroups:[cg-1,cg-2]

Show Sub-Attributes

string

remoteOfficesJSON ArrayOptional

Specify the required list of Ip addresses for deployment ex:remoteOffices:[Local Office,Remote-1]

Show Sub-Attributes

string

ipAddressesJSON ArrayOptional

Specify the required list of Custom Group names for deployment ex:ipAddresses:[127.0.0.1,126.0.0.1]

Show Sub-Attributes

string

retrySettingsJSON ObjectOptional

Enabling this option will redeploy the configuration on failed targets.E.g. "retrySettings":{"enableRetrySettings": true,"noOfRetries": 2,"logonStartupMinRetry": 1,"refreshMinRetry": 1}enableRetrySettings,true : To enable retry settings,false: To disable retry settings,noOfRetries:Total number of retries count , Accepted values 1-10,logonStartupMinRetry Retry during system startup,refreshMinRetry Retry during refresh cycle,Note : Enabled by default. To disable, set 'enableRetrySettings' to false. Retry count: logonStartupMinRetry + refreshMinRetry.

Show Sub-Attributes

enableRetrySettingsbooleanOptional

true-To enable retry, false-To disable retry.

noOfRetriesstringOptional

Specify retry values range from 1-10

logonStartupMinRetrystringOptional

Specify retry count range from 0-9 during user logon

refreshMinRetrystringOptional

Specify the retry count range (0â€“9) for computers that complete the 90-minute refresh cycle.

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomains/api/1.4/patch/installpatch \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{}'

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

import http.client

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

payload = "{}"

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

conn.request("POST", "/api/1.4/patch/installpatch", 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();

    response = invokeUrl
    [
        url: "https://appDomains/api/1.4/patch/installpatch"
        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/installpatch' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'

Sample Request Body

Copied!

  {
    "PatchIDs": [
      103980
    ],
    "retrySettings": {
      "logonStartupMinRetry": 1,
      "noOfRetries": 2,
      "refreshMinRetry": 1,
      "enableRetrySettings": true
    },
    "deploymentType": 2,
    "deadlineTime": 1691393760,
    "ConfigName": "API install patch test1",
    "ResourceIDs": [
      601
    ],
    "actionToPerform": "Deploy",
    "ConfigDescription": "API test",
    "forceRebootOption": 2,
    "DeploymentPolicyTemplateID": 1
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!

  {
    "message_type": "installpatch",
    "message_response": {
      "installpatch": {}
    },
    "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.