Retrieve Patch Report for a System 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 the list of patches and their status for a specific computer managed by.

This API endpoint is deprecating soon

Endpoints

Request URL

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

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
residstringOptional

Filter for system with a resource id

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

platformfilterstringOptional

Windows/Mac/Linux

patchstatusfilterintegerOptional

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

approvalstatusfilterintegerOptional

211: Approved — patch has been approved for deployment, 0: Not Approved — patch approval is pending, 212: Declined — patch has been declined

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
taskidlongOptional

Sample Request

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

Response Parameters

- HTTP code 200

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

Value: systemreport

message_responseJSON Object

Paginated system patch report data

Show Sub-Attributes
totalstring

Total number of patch records for the system

systemreportJSON Array

Array of patch objects for the given system

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

severity_namestring

Severity label (e.g., dc.common.CRITICAL)

pmseverity.namestring

Human-readable severity name

patch_typestring

Patch type code

update_namestring

Update category name

vendor_namestring

Vendor name

platform_namestring

Platform name

patch_statusstring

Approval status: 211=Approved, 212=Declined

affected_patch_statusstring

Installation status: 201=Installed, 202=Missing, 203=Failed

affectedpatchstatusdefn.labelstring

Status label (e.g., dc.common.INSTALLED)

download_statusstring

Download status code

deployment_statusstring

Deployment status code

patch_released_timelong

Patch release timestamp

patch_norebootstring

Reboot: 0=Not Required, 1=Required

patch_uninstall_statusstring

Uninstall: 0=Not Supported, 1=Supported

superceded_bystring

Superseding patch ID, or NA

installed_timelong

Timestamp when patch was installed, or -- if not installed

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 list of patches for a specific system

Copied!
  {
    "response_code": 200,
    "message_type": "systemreport",
    "message_response": {
      "total": 64,
      "systemreport": [
        {
          "severity": 4,
          "affected_patch_status": 201,
          "patch_id": 9110,
          "patch_name": "office2007-kb2288621-fullfile-x86-glb.exe",
          "patch_description": "Security Update for the 2007 Microsoft Office System (KB2288621)",
          "vendor_name": "Microsoft",
          "deployment_status": 209,
          "superceded_by": "NA",
          "severity_name": "dc.common.CRITICAL",
          "bulletin_id": "MS10-063",
          "update_name": "Security Updates",
          "patch_noreboot": 0,
          "patch_released_time": 1284402600000,
          "affectedpatchstatusdefn.label": "dc.common.INSTALLED",
          "patch_uninstall_status": 1,
          "platform_name": "Windows",
          "download_status": 221,
          "patch_type": 0,
          "installed_time": 1544818523000,
          "pmseverity.name": "Critical",
          "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.