Retrieve Specified Patch Details Deprecating soon

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

Retrieves detailed audit-level information about a specific patch installation status across all applicable systems.

This API endpoint is deprecating soon

Endpoints

Request URL

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

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

searchvaluestringOptional
searchcolumnstringOptional
searchtypestringOptional
sortorderstringOptional
orderbystringOptional
pagelimitstringOptional

Number of records per page.

pageintegerOptional

Current page number for pagination.

customeridlongOptional
patchidstringOptional
residstringOptional
domainfilterstringOptional

Get domain list from api/1.4/desktop/serverproperties

branchofficefilterstringOptional

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

customgroupfilterstringOptional

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

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

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
platformfilterstringOptional

Windows/Mac/Linux

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/api/1.4/patch/patchdetails \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Value: patchdetails

message_responseJSON Object

Paginated patch-level audit data per system

Show Sub-Attributes
totalstring

Total number of patch detail records

patchdetailsJSON Array

Array of patch detail objects per system

Show Sub-Attributes
JSON Object
Show Sub-Attributes
resource_idlong

Resource ID of the system

resource.namestring

Computer name

resource.domain_netbios_namestring

Domain name

ip_addressstring

System IP address

os_namestring

Operating system name

service_packstring

Service pack or OS version

patch_idlong

Unique patch identifier

patch_namestring

Patch filename or KB name

patch_descriptionstring

Detailed patch description

bulletin_idstring

Security bulletin identifier

severitystring

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

pmseverity.namestring

Human-readable severity name

update_namestring

Update type: Security Updates, Third Party Updates, etc.

vendor_namestring

Patch vendor name

patch_released_timelong

Patch release timestamp

patch_sizelong

Patch file size in bytes

superceded_bystring

Patch ID that supersedes this patch, 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

Patch details with system-level status

Copied!
  {
    "response_code": 200,
    "message_type": "patchdetails",
    "message_response": {
      "total": 5,
      "limit": 25,
      "patchdetails": [
        {
          "severity": 3,
          "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",
          "superceded_by": "NA",
          "ip_address": "172.24.143.191",
          "bulletin_id": "MS18-JAN9",
          "update_name": "Security Updates",
          "patch_released_time": 1515715200000,
          "patch_size": 0,
          "resource.domain_netbios_name": "DOMAIN",
          "service_pack": "Windows Server 2012 R2 Gold (x64)",
          "resource_id": 50924,
          "os_name": "Windows Server 2012 R2 Standard Edition (x64)",
          "pmseverity.name": "Important"
        }
      ],
      "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.