Retrieve Installed Patches Across Managed Systems Deprecating soon

Retrieves a paginated list of patches that have been successfully installed across managed systems including severity, vendor, and installed system counts.

This API endpoint is deprecating soon

Endpoints

get /api/1.4/patch/installedpatches

Copy full URL

Request URL

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

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

loginidstringOptional

resource_idstringOptional

{resource_id} - Unique identifier of the computer

useridstringOptional

usernamestringOptional

ticketstringOptional

customeridstringOptional

customerNamestringOptional

customernamestringOptional

residfilterintegerOptional

Filter computer with particular resource id

domainfilterstringOptional

Get domain list from api/1.4/desktop/serverproperties

branchofficefilterstringOptional

Get branch office list from api/1.4/desktop/serverproperties

remoteofficefilterstringOptional

customgroupfilterstringOptional

Get custom group list from api/1.4/desktop/serverproperties

livestatusfilterintegerOptional

1 - Live: System is working.
2 - Down: System is not working.
3 - Unknown: System status is not known.

platformfilterstringOptional

connidfilterstringOptional

pagestringOptional

pagelimitstringOptional

orderbystringOptional

sortorderstringOptional

sortcolumnstringOptional

searchtypestringOptional

searchcolumnstringOptional

searchvaluestringOptional

patchidstringOptional

residstringOptional

{resid} - Unique identifier of the computer

languagefilterintegerOptional

approvalstatusfilterintegerOptional

downloadstatusfilterintegerOptional

supercedestatusfilterintegerOptional

healthfilterintegerOptional

severityfilterintegerOptional

patchtypefilterintegerOptional

patchstatusfilterintegerOptional

agentinstallationstatusfilterintegerOptional

installstatusfilterintegerOptional

21: Yet to install (agent has not been installed).
22: Installed (agent is currently installed).
23: Uninstalled (agent has been removed).
24: Yet to uninstall (marked for uninstallation but not yet removed).
29: Installation failure (an error occurred during installation).

licensetypefilterintegerOptional

1: Commercial (used for business or paid purposes).
2: Non-commercial (used for personal or educational purposes).
0: Unidentified (license type not specified).

scanstatusfilterintegerOptional

-1: Not done scan has not started.
0: Failed scan failed.
1: In progress scan is ongoing.
2: Success scan completed successfully.

deploymentstatusfilterintegerOptional

configtypefilterintegerOptional

accesstypefilterintegerOptional

1: Allowed (access is permitted).
2: Prohibited (access is restricted).
0: Not assigned (no access configuration).

compliancestatusfilterintegerOptional

0: Under licensed (fewer licenses than required).
1: Over licensed (more licenses than needed).
2: In compliance (license usage matches availability).
3: Expired (license validity has ended).
-1: Not available (compliance data is missing).

complianceStatusFilterintegerOptional

bulletinidstringOptional

oscompatibilityfilterstringOptional

32-bit: For 32-bit operating systems.
64-bit: For 64-bit operating systems.

uninstallsupportfilterstringOptional

Yes: Supports uninstallation.
No: Does not support uninstallation.

installerformatfilterstringOptional

MSI: Installed via MSI installer.
EXE: Installed via EXE installer.

licensefilterstringOptional

Get License List from api/1.4/inventory/licenses?swid={softwareID} in license_id parameter inside message response

hardwaretypefilterstringOptional

Get hardware type list from api/1.4/inventory/filterparams

manufacturerfilterstringOptional

Get hardware manufacturer list from api/1.4/inventory/filterparams

osfilterstringOptional

vendorfilterstringOptional

policynamestringOptional

configstatusfilterstringOptional

viewtypefilterstringOptional

latestpatchesstringOptional

prohibitedswidstringOptional

unique identifier of the prohibited software

categoryfilterstringOptional

ticketidstringOptional

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomains/api/1.4/patch/installedpatches \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

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/installedpatches"))
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

headers = { 'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52" }

conn.request("GET", "/api/1.4/patch/installedpatches", headers=headers)

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

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


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

    response = invokeUrl
    [
        url: "https://appDomains/api/1.4/patch/installedpatches"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/api/1.4/patch/installedpatches' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

message_typestring

Value: installedpatches

message_responseJSON Object

Paginated installed patches data

Show Sub-Attributes

totalstring

Total number of installed patches

installedpatchesJSON Array

Array of installed patch objects

Show Sub-Attributes

JSON Object

Show Sub-Attributes

patch_idlong

Unique patch identifier

bulletin_idstring

Security bulletin identifier

patch_namestring

Patch filename

patch_descriptionstring

Patch description

severitystring

Severity: 0=Unrated, 1=Low, 2=Moderate, 3=Important, 4=Critical

installedstring

Count of systems where this patch is installed

platform_namestring

Platform name

update_namestring

Update category

patch_released_timelong

Patch release timestamp

patch_uninstall_statusstring

Uninstall: 0=Not Supported, 1=Supported

patch_sizelong

Patch file size in bytes

vendor_namestring

Vendor name

superceded_bystring

Superseding patch ID, or NA

limitstring

Records per page

pagestring

Current page number

message_versionstring

API version: 1.0

statusstring

Operation status: success

response_codestring

Response code: 200

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Paginated installed patches

Copied!

  {
    "response_code": 200,
    "message_type": "installedpatches",
    "message_response": {
      "total": 2307,
      "installedpatches": [
        {
          "severity": 1,
          "installed": 48,
          "patch_id": 309239,
          "patch_name": "BANDIZIP-SETUP.EXE",
          "patch_description": "Bandizip (6.22.0.0)",
          "vendor_name": "Bandisoft",
          "superceded_by": "NA",
          "bulletin_id": "TU-075",
          "update_name": "Third Party Updates",
          "patch_released_time": 1552974574000,
          "patch_size": 6537016,
          "patch_uninstall_status": 0,
          "platform_name": "Windows"
        }
      ],
      "limit": 25,
      "page": 1
    },
    "message_version": "1.0",
    "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.