List Patch Status Across Computers Deprecating soon

This API provides detailed information about the installation status of a given patch on all applicable computers within the Endpoint Central environment.

This API endpoint is deprecating soon

Endpoints

get /api/1.4/patch/allpatchdetails

Copy full URL

Request URL

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

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

patchidstringOptional

Filter for patch with a particular id

bulletinidstringOptional

severityfilterintegerOptional

0: Unrated — no severity assigned, 1: Low — minimal impact, 2: Moderate — average impact, 3: Important — significant impact, 4: Critical — high impact or security risk

patchstatusfilterintegerOptional

201: Installed — patch is already installed, 202: Missing — patch is not installed

domainfilterstringOptional

Get domain list from api/1.4/desktop/serverproperties

platformfilterstringOptional

Windows/Mac/Linux

branchofficefilterstringOptional

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

customgroupfilterstringOptional

Get Custom Group list from api/1.4/desktop/serverproperties

searchvaluestringOptional

searchcolumnstringOptional

searchtypestringOptional

sortorderstringOptional

orderbystringOptional

pagelimitstringOptional

Number of records per page.

pageintegerOptional

Current page number for pagination.

customeridlongOptional

languagefilterintegerOptional

patchtypefilterintegerOptional

0: Security Updates, 1: Critical Updates, 2: Third-Party Updates, 3: Updates, 4: Definition Updates, 5: Service Packs, 6: Feature Packs, 7: Rollups, 8: Tools, 9: Driver, 10: Optional Updates, 11: Preview Rollups, 12: BIOS

deploymentstatusfilterintegerOptional

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/api/1.4/patch/allpatchdetails \
  --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://appdomain/api/1.4/patch/allpatchdetails"))
        .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("appdomain")

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

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

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

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


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

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

    info response;

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

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object

Hide Sub-Attributes

LinksJSON object

Pagination links for next and previous pages

Show Sub-Attributes

nextstring

URL for the next page of results, or null if on the last page

prevstring

URL for the previous page of results, or null if on the first page

messageResponseJSON array

Array of patch-system mapping entries

Show Sub-Attributes

JSON object

Show Sub-Attributes

affected_patch_statusstring

Affected patch status code

agent_last_bootup_timestring

Agent last bootup time in epoch milliseconds

agent_last_contact_timestring

Agent last contact time in epoch milliseconds

agent_last_contact_time_transformstring

Formatted agent last contact time

agent_logged_on_usersstring

Logged on users on the agent

agent_logged_on_users_transformstring

Transformed logged on users

agent_versionstring

Agent version string

agent_version_transformstring

Transformed agent version

branch_office_namestring

Branch office name

branch_office_name_transformstring

Transformed branch office name

bulletin_idstring

Security bulletin identifier

bulletin_id_transformstring

Transformed bulletin ID

collection_namestring

Collection name, or null

collection_name_transformstring

Transformed collection name

computer_live_statusstring

Computer live status code

computer_status_update_timestring

Computer status update time in epoch milliseconds

config_idstring

Configuration ID, or null

config_id_transformstring

Transformed configuration ID

deploy_remarksstring

Deployment remarks, or null

deploy_remarks_argsstring

Deployment remarks arguments, or null

deploy_remarks_transformstring

Transformed deployment remarks

deployer_first_namestring

Deployer first name, or null

deployer_first_name_transformstring

Transformed deployer name

deployment_statusstring

Deployment status, or null

domain_netbios_namestring

Domain NetBIOS name

domain_netbios_name_transformstring

Transformed domain name

first_namestring

Name of the user who approved the patch

first_name_transformstring

Transformed approving user name

friendly_namestring

Friendly computer name

friendly_name_transformstring

Transformed friendly name

i18nstring

Internationalization language

i18n_transformstring

Transformed i18n value

image_namestring

Image path for approval status

install_error_codestring

Installation error code, or null

installed_timestring

Installation time in epoch milliseconds, or null

installed_time_transformstring

Formatted installation time

ip_addressstring

IP address of the system

ip_address_transformstring

Transformed IP address

labelstring

Approval status label key

label_transformstring

Transformed approval status display

mac_addressstring

MAC address of the system

mac_address_transformstring

Transformed MAC address

managedcomputer_resource_idstring

Managed computer resource ID

os_languagestring

OS language code

os_namestring

Operating system name

os_name_transformstring

Transformed OS name

os_platformstring

OS platform code

patch_affected_status_imagestring

Image path for patch affected status

patch_affected_status_labelstring

Patch affected status label key

patch_affected_status_label_transformstring

Transformed patch affected status

patch_descriptionstring

Full description of the patch

patch_description_transformstring

Transformed patch description

patch_idstring

Unique patch identifier

patch_id_transformstring

Transformed patch ID

patch_install_status_imagestring

Image path for install status, or null

patch_install_status_labelstring

Install status label, or null

patch_install_status_label_transformstring

Transformed install status label

patch_namestring

Patch file name

patch_name_transformstring

Transformed patch file name

patch_released_timestring

Patch release time in epoch milliseconds

patch_released_time_transformstring

Formatted patch release date

patch_sizestring

Patch file size in bytes

patch_size_transformstring

Formatted patch file size

patch_statusstring

Patch status code

patch_supported_timestring

Patch supported time in epoch milliseconds

patch_supported_time_transformstring

Formatted patch supported date

patch_typestring

Patch type code

patch_uninstall_statusstring

Uninstall support status code

patch_uninstall_status_transformstring

Transformed uninstall status display

patch_updated_timestring

Last updated time in epoch milliseconds

patch_updated_time_transformstring

Formatted last updated date and time

platformstring

Platform code: 1=Windows, 2=Mac, 3=Linux

platform_namestring

Platform display name

pmseverity_namestring

Severity display name

resource_idstring

Resource identifier

resource_namestring

Resource/computer name

resource_name_transformstring

Transformed resource name

resourcemacip_resource_idstring

Resource MAC/IP resource ID

service_packstring

Service pack version

service_pack_transformstring

Transformed service pack

severitystring

Severity code

severity_namestring

Severity label key

severity_transformstring

Transformed severity display

sqnumberstring

Software version/sequence number

sqnumber_transformstring

Transformed version number

superceded_bystring

Superceded by patch ID, or NA

superceded_by_transformstring

Transformed superceded by value

update_namestring

Update type name

update_name_transformstring

Transformed update type name

user_idstring

User ID of approver

vendor_namestring

Vendor name

vendor_name_transformstring

Transformed vendor name

metadataJSON object

Pagination metadata

Show Sub-Attributes

limitstring

Number of records per page

pagestring

Current page number

statusstring

Operation result: success

totalPagesstring

Total number of pages available

totalRecordsstring

Total number of records matching the query

Possible HTTP Status Codes

200HTTP code

Sample Response: HTTP 200

Paginated list of patch status across all applicable systems

Copied!

  {
    "response_code": 200,
    "message_type": "allpatchdetails",
    "message_response": {
      "total": 5,
      "allpatchdetails": [
        {
          "severity": 3,
          "branch_office_name": "Local Office",
          "patch_id": 23956,
          "resource.name": "COMPUTER-01",
          "patch_name": "SQLPreReqHandler_KB4057116_x64.exe",
          "patch_description": "Security update for SQL Server 2012 SP4 x64 (KB4057116)",
          "vendor_name": "Microsoft",
          "deployment_status": "--",
          "superceded_by": "NA",
          "ip_address": "172.24.143.191",
          "bulletin_id": "MS18-JAN9",
          "update_name": "Security Updates",
          "patch_released_time": 1515715200000,
          "patch_size": 0,
          "affectedpatchstatusdefn.label": "dc.common.INSTALLED",
          "agent_version": "10.0.267.W",
          "resource.domain_netbios_name": "DOMAIN",
          "service_pack": "Windows Server 2012 R2 Gold (x64)",
          "patch_uninstall_status": 0,
          "os_name": "Windows Server 2012 R2 Standard Edition (x64)",
          "patch_type": 0,
          "resource.resource_id": 50924,
          "pmseverity.name": "Important",
          "patch_status": 211
        }
      ],
      "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.