Retrieve Latest Patches Report

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 a report of the most recently released patches.

Request URL

https://{serverurl}/dcapi/patch/reports/latestPatches Copied!

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/patchReports.v1+jsonapplication/patchReports.v1+jsonCopied!

- Query Parameters

pageLimitintegerOptional

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.

searchColumnstringOptional

Name of the column in which the search value needs to be looked up. Use together with searchValue.

searchValuestringOptional

Text to look up in the column given in searchColumn. Use together with searchColumn.

platformlongOptional

Returns only the systems or patches belonging to the given operating system platform. Accepted values: 1 - Windows, 2 - Mac, 3 - Linux. Provide a single numeric value.

patchIdlongOptional

Unique identifier of the patch to which the data needs to be filtered. Get the value from Get Supported Patches

severitylongOptional

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

approvalStatuslongOptional

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

kbnumberstringOptional

Returns only the patches whose KB (knowledge base) article number contains the given value. For example, 5031356. Partial values are matched.

patchStatusstringOptional

Returns only the patches with the given status on the systems. Accepted values: 201 - Installed, 202 - Missing. Multiple values can be given as a comma-separated list.

patchTypeParamstringOptional

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.

cveIdstringOptional

Returns only the patches that fix the given CVE (Common Vulnerabilities and Exposures) identifier, for example, CVE-2023-12345.

bulletinIdstringOptional

Returns only the patches released under the given bulletin. A bulletin is the vendor advisory a patch is published under, for example MS15-041. Enter the Bulletin ID exactly as shown in the patch list. Get the bulletin ID from Get Supported Patches.

isWebViewstringOptional

Indicates whether the response is requested for the web console. Set to True to get the response in the format used by the web console; leave empty for the default API response.

skipColumnsstringOptional

Comma-separated list of column names that should be left out of the response, to get a lighter response with only the columns you need.

- Request Body

application/json
JSON Object
Hide Sub-Attributes
dcViewFilterIDintegerOptional

View filter ID for saved custom view

criteriaJSONJSON ArrayOptional

Array of filter criteria for the report view

Show Sub-Attributes
JSON Object
Show Sub-Attributes
columnIDlongMandatory

Column identifier for the filter criterion

searchValueJSON ArrayOptional

Array of search values for the filter

Show Sub-Attributes
string
comparatorstringMandatory

Comparison operator (e.g., equals, contains, greater_than)

customComparatorstringOptional

Custom comparator override for special filter logic

logicalOperatorstringMandatory

Logical operator to combine with next criterion (AND/OR)

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/patch/reports/latestPatches \
  --header 'Accept: application/patchReports.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{}'

Sample Request Body

Copied!
  {
    "dcViewFilterID": 0,
    "criteriaJSON": [
      {
        "columnID": 0,
        "searchValue": [
          "string"
        ],
        "comparator": "string",
        "customComparator": "string",
        "logicalOperator": "string"
      }
    ]
  }
                
▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
messageResponseJSON Array

Array of latest patch entries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
bulletin_idstring

Security bulletin identifier

bulletin_id_transformstring

Transformed bulletin ID

customer_idstring

Customer identifier

download_statusstring

Download status, or null

first_namestring

Name of the user who approved the patch

first_name_transformstring

Transformed approving user name

is_supercededstring

Whether patch is superceded: 0=No, 1=Yes

labelstring

Approval status label key

label_transformstring

Transformed approval status display

newpatchinfo_patchidstring

New patch info patch ID

patch_descriptionstring

Full description of the patch

patch_description_transformstring

Transformed patch description

patch_download_status_imagestring

Image path for download status, or null

patch_download_status_labelstring

Label for download status, or null

patch_idstring

Unique patch identifier

patch_langstring

Patch language code

patch_namestring

Patch file name

patch_name_transformstring

Transformed patch file name

patch_norebootstring

Reboot requirement code: 0=Required, 1=May Require

patch_noreboot_transformstring

Transformed reboot requirement display

patch_patchidstring

Patch ID reference

patch_patchid_transformstring

Transformed patch ID reference

patch_released_timestring

Patch release time in epoch milliseconds

patch_released_time_transformstring

Formatted patch release date

patch_remarksstring

Patch remarks

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_updatedstring

Patch updated time in epoch milliseconds

patch_updated_timestring

Last updated time in epoch milliseconds

patch_updated_time_transformstring

Formatted last updated date and time

patchdetails_patchidstring

Patch details patch ID

platformstring

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

platform_namestring

Platform display name

platform_name_transformstring

Transformed platform name

pmpatchlocation_patchidstring

PM patch location patch ID

pmpatchtype_statusstring

PM patch type status code

pmseverity_namestring

Severity display name

severitystring

Severity code

severity_namestring

Severity label key

severity_transformstring

Transformed severity display

sqnumberstring

Software version/sequence number

sqnumber_transformstring

Transformed version number

status_imagestring

Image path for approval status

superceded_bystring

Superceded by patch ID, or NA

update_idstring

Update type ID

update_namestring

Update type name

update_name_transformstring

Transformed update type name

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

- 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

- HTTP code 500

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

Error code: INTERNAL_ERROR for server-side failures

error_descriptionstring

Localized error description: dc.rest.api_internal_error

Sample Response: HTTP 200

Latest patches

Copied!
  {
    "Links": {
      "next": "/dcapi/patch/reports/latestPatches?page=2&pageLimit=25",
      "prev": null
    },
    "messageResponse": [
      {
        "bulletin_id": "TU-1184",
        "bulletin_id_transform": "TU-911",
        "customer_id": "16222000000226138",
        "download_status": null,
        "first_name": "DC-SYSTEM-USER",
        "first_name_transform": "DC-SYSTEM-USER",
        "is_superceded": "0",
        "label": "dc.common.APPROVED",
        "label_transform": "Approved",
        "newpatchinfo_patchid": "343878",
        "patch_description": "Think-cell 12 (12.0.35.620) (Manual Upload Required)",
        "patch_description_transform": "Razor SQL (x64) (10.6.4)",
        "patch_download_status_image": null,
        "patch_download_status_label": null,
        "patch_id": "343878",
        "patch_lang": "0",
        "patch_name": "setup_think-cell_35620.msi",
        "patch_name_transform": "razorsql10_6_4_setup_x64.exe",
        "patch_noreboot": "1",
        "patch_noreboot_transform": "May Require",
        "patch_patchid": "343878",
        "patch_patchid_transform": "343852",
        "patch_released_time": "1734006889000",
        "patch_released_time_transform": "Dec 12, 2024",
        "patch_remarks": "",
        "patch_size": "101543936",
        "patch_size_transform": "94.25 MB",
        "patch_status": "211",
        "patch_supported_time": "1734006889000",
        "patch_supported_time_transform": "Dec 12, 2024",
        "patch_type": "2",
        "patch_uninstall_status": "0",
        "patch_uninstall_status_transform": "Not Supported",
        "patch_updated": "1734008431000",
        "patch_updated_time": "1770718649504",
        "patch_updated_time_transform": "Feb 10, 2026 03:47 PM",
        "patchdetails_patchid": "343878",
        "platform": "1",
        "platform_name": "Windows",
        "platform_name_transform": "Windows",
        "pmpatchlocation_patchid": "343878",
        "pmpatchtype_status": "0",
        "pmseverity_name": "Moderate",
        "severity": "2",
        "severity_name": "dc.common.MODERATE",
        "severity_transform": "Moderate",
        "sqnumber": "12.0.35.620",
        "sqnumber_transform": "10.6.4",
        "status_image": "images/approved_icon.gif",
        "superceded_by": "NA",
        "update_id": "2",
        "update_name": "Third Party Updates",
        "update_name_transform": "Third Party Updates",
        "vendor_name": "think-cell Operations GmbH",
        "vendor_name_transform": "Richardson Software, LLC"
      }
    ],
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "status": "success",
    "totalPages": 943,
    "totalRecords": "23569"
  }
                
▼ 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

Sample Response: HTTP 500

Server-side error

Copied!
  {
    "error_code": "INTERNAL_ERROR",
    "error_description": "dc.rest.api_internal_error"
  }
                
▼ Show full

Duration: 1 minute | Threshold: 50 | 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.