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

View new endpoint   >

Request URL

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

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

searchvaluestringOptional

Text to look up in the column given in searchcolumn. Use together with searchtype and searchcolumn.

searchcolumnstringOptional

Name of the column (field) in the response in which the search text is looked up. Use together with searchtype and searchvalue.

searchtypestringOptional

Type of search to be performed on the column, for example, contains. Search is applied only when searchtype, searchcolumn and searchvalue are all provided.

sortorderstringOptional

Direction in which the records are sorted. Allowed values: ASC (ascending) and DESC (descending). Use together with orderby.

orderbystringOptional

Name of the column (field) in the response by which the records are sorted. Use together with sortorder.

pagelimitstringOptional

Number of records to be returned per page. Minimum 1, maximum 1000. Default is 25.

pageintegerOptional

Page number of the result set to be returned. Minimum 1, maximum 100000. Default is 1.

residstringOptional

Filter for system with a resource id. Fetch from Get All Systems

severityfilterintegerOptional

Returns only the patches of the given severity. Accepted values: 0 - Unrated, 1 - Low, 2 - Moderate, 3 - Important, 4 - Critical.

platformfilterstringOptional

Returns only the records of the given operating system platform. Accepted values: windows, mac, linux.

patchstatusfilterintegerOptional

Returns only the patches with the given status on the systems. Accepted values: 201 - Installed, 202 - Missing.

approvalstatusfilterintegerOptional

Returns only the patches with the given approval status. Accepted values: 211 - Approved, 0 - Not Approved, 212 - Declined.

languagefilterintegerOptional

Returns only the patches released for the given language. Provide the language ID as listed in Endpoint Central.

patchtypefilterintegerOptional

Returns only the patches of the given update type. Accepted values: 0 - Security Updates, 1 - Non-Security Updates, 2 - Third Party Updates, 4 - Definition Updates, 5 - Service Packs, 6 - Feature Packs, 7 - Rollups, 8 - Tools, 9 - Drivers, 10 - Optional Updates, 11 - Preview Rollups, 12 - BIOS.

deploymentstatusfilterintegerOptional

Returns only the configurations with the given deployment status. Accepted values: 3 - In Progress, 6 - Succeeded, 10 - In Progress with Failures, 12 - Yet to Deploy, 16 - Failed.

taskidlongOptional

ID of the Automated Patch Deployment task. Fetch from Get APD Tasks

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/api/1.4/patch/systemreport \
  --header 'Accept: application/json' \
  --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

- HTTP code 401

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

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

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

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

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

Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

errorMsgstring

Rate limit exceeded message with retry guidance

Sample Response: HTTP 200

Copied!
  {
    "message_type": "systemreport",
    "message_response": {
      "total": 26,
      "systemreport": [
        {
          "update_id": 0,
          "installstatusdefn.label": "dc.common.INSTALLED",
          "installpatchstatus.patch_id": 9110,
          "install_error_code": -1,
          "bulletin_id": "MS10-063",
          "patch_noreboot": 0,
          "update_name": "Security Updates",
          "platform": 1,
          "configstatusdefn.image_name": "/images/approved_icon.gif",
          "deploy_remarks": "dc.db.agent.config.patchscan.success",
          "patch_released_time": 1284402600000,
          "customerpatchstatus.patch_id": 9110,
          "patch_uninstall_status": 1,
          "download_status": 221,
          "platform_name": "Windows",
          "affectedpatchstatusdefn.image_name": "/images/success.gif",
          "patch_type": 0,
          "pmseverity.name": "Critical",
          "patch_status": 211,
          "affected_patch_status": 201,
          "severity": 4,
          "patchstorestatusdefn.label": "dc.common.SUCCESS",
          "configstatusdefn.label": "dc.common.APPROVED",
          "patch_id": 9110,
          "patch_name": "office2007-kb2288621-fullfile-x86-glb.exe",
          "collection.collection_name": "MyTask682",
          "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",
          "installpatchstatus.resource_id": 301,
          "deployer.first_name": "admin",
          "patchstorestatusdefn.image_name": "/images/download_success.png",
          "installstatusdefn.image_name": "/images/success.png",
          "patch_supported_time": 1284402600000,
          "affectedpatchstatusdefn.label": "dc.common.INSTALLED",
          "resource_id": 301,
          "customer_id": 1,
          "deploy_remarks_args": "--",
          "installed_time": 1544818523000
        }
      ],
      "limit": 25,
      "page": 2
    },
    "message_version": "1.0",
    "status": "success",
    "response_code": 200
  }
                
▼ Show full

Sample Response: HTTP 401

Authentication credentials are missing, expired or invalid

Copied!
  {
    "error_code": "UAC_UNAUTHORIZED",
    "error_description": "dc.rest.authentication.unauthorized"
  }
                
▼ Show full

Sample Response: HTTP 403

Authenticated user lacks the required role or scope

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMessage": "You do not have sufficient privileges to perform this operation"
  }
                
▼ Show full

Sample Response: HTTP 429

API call threshold exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMessage": "API call limit exceeded. Retry after the lock period elapses"
  }
                
▼ 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.