Retrieve All Applicable Patches

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 comprehensive list of all patches applicable to systems, with extensive filter support for targeted querying.

Endpoint

Request URL

https://{serverurl}/dcapi/threats/patches Copied!

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

pagestringOptional

Page number of the result set to be returned. Minimum 1, maximum 1000.

cveidsstringOptional

Returns only the patches that fix the given CVE ID. Example: CVE-2024-21412.

reboot_requiredstringOptional

Returns only the patches with the given reboot requirement. Accepted values: required, not required, autoreboot, may require.

vendor_namestringOptional

Returns only the patches released by the given vendor. Example: Microsoft. Get the vendor name from Get Supported Patches api.

update_typestringOptional

Returns only the patches of the given update type. (Applicable inputs: Security Updates, Non-Security Updates, Third-Party Updates, Definition Update, Service Packs, Feature Packs, Rollups, Tools, Driver, Optional Updates, Preview Rollups and BIOS)

severitystringOptional

Returns only the patches of the given severity. Accepted values: Unrated, Low, Moderate, Important, Critical.

platform_namestringOptional

Returns only the patches of the given operating system platform. Accepted values: Windows, Mac, Linux.

patch_released_timestringOptional

Returns only the patches released at the given time. Provide the release time as epoch milliseconds. Multiple values can be given as a comma-separated list.

patch_statusstringOptional

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

patch_descriptionstringOptional

Returns only the patches whose description contains the given text. Example: Security Update for Windows.

patchnamestringOptional

Returns only the patches whose name contains the given text. Example: KB5034441. Get patch names from Get Supported Patches api.

bulletinidstringOptional

Returns only the patches that belong to the given security bulletin. Provide the bulletin ID published by the vendor, for example, MS15-041 or TU-636. Get the bulletin ID from Get Supported Patches api.

patchidstringOptional

Filters patches based on the patch ID provided. Fetch from Get Supported Patches

patch_uninstallstringOptional

Filters patches based on the patch uninstallation support (as specified by the vendor).

updated_timestringOptional

Filters patches based on the approved time.

kb_numberstringOptional

Filters patches based on the provided KB number.

supercededbystringOptional

ID of the patch that supersedes this patch

patch_supported_timestringOptional

Filters patches based on the provided patch support date.

patch_sizestringOptional

Filters patches based on the provided size.

approveduser_first_namestringOptional

Filters patches based on the post-deployment reboot option configured. (Applicable inputs: required, not required, autoreboot, may require)

download_statusstringOptional

Filters patches based on the download status provided.

installed_system_countstringOptional

Number of systems on which the patch is installed

missing_system_countstringOptional

Number of systems on which the patch is missing

failed_system_countstringOptional

Number of systems on which the patch installation failed

pageLimitstringOptional

Number of patches to be returned per page. Minimum 1, maximum 1000.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/threats/patches \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Contains the patches array

Show Sub-Attributes
patchesJSON Array

Array of patch objects with threat data

Show Sub-Attributes
JSON Object
Show Sub-Attributes
approveduser_first_namestring

First name of the user who approved the patch

bulletinidstring

Security bulletin identifier (e.g., MS15-041)

download_statusstring

Current download status of the patch, or -- if not downloaded

failed_system_countstring

Number of systems where installation failed

installed_system_countstring

Number of systems where this patch is installed

kb_numberstring

Knowledge base article number

missing_system_countstring

Number of systems where this patch is missing

patch_descriptionstring

Full description of the patch

patch_released_timestring

Patch release timestamp in milliseconds since epoch

patch_sizestring

Patch file size in bytes

patch_statusstring

Approval status: approved, unapproved, declined

patch_supported_timestring

Timestamp when the patch was added to the supported list

patch_uninstallstring

Uninstall support: supported, not supported

patchidstring

Unique patch identifier

patchnamestring

Patch file name

platform_namestring

Target platform: Windows, Mac, Linux

reboot_requiredstring

Reboot requirement: required, not required, autoreboot, may require

severitystring

Patch severity: Critical, Important, Moderate, Low, Unrated

supercededbystring

Patch ID that supersedes this patch, or NA if none

update_typestring

Patch type: Security Updates, Non-Security Updates, Third-Party Updates, Definition Update, Service Packs, Feature Packs, Rollups, Tools, Driver, Optional Updates, Preview Rollups, BIOS

updated_timestring

Last updated timestamp in milliseconds since epoch

vendor_namestring

Vendor name (e.g., Microsoft)

message_typestring

Response type identifier: patches

metadataJSON Object

Pagination metadata including page info and navigation links

Show Sub-Attributes
pageLimitstring

Number of records per page

totalRecordsstring

Total number of matching records as a string

totalPagesstring

Total number of pages available

pagestring

Current page number

response_codestring

Response code: 200 for success

statusstring

Operation result: success

- 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!
  {
    "metadata": {
      "pageLimit": 30,
      "totalRecords": "2",
      "totalPages": 1,
      "links": {
        "next": null,
        "prev": null
      },
      "page": 1
    },
    "response_code": 200,
    "message_type": "patches",
    "message_response": {
      "patches": [
        {
          "severity": "Important",
          "patchname": "vcredist_x86_sp1.exe",
          "updated_time": "1704363395117",
          "update_type": "Security Updates",
          "patch_description": "Microsoft Visual C++ 2010        Service Pack 1 Redistributable Package MFC Security        Update",
          "kb_number": "2565063",
          "vendor_name": "Microsoft",
          "installed_system_count": 1,
          "supercededby": "NA",
          "patch_released_time": "1307989800000",
          "patch_supported_time": "1307989800000",
          "patch_size": "8993744",
          "patchid": "12621",
          "patch_uninstall": "not supported",
          "bulletinid": "MS11-025",
          "approveduser_first_name": "DC-SYSTEM-USER",
          "reboot_required": "may require",
          "platform_name": "Windows",
          "download_status": "--",
          "missing_system_count": 0,
          "failed_system_count": 0,
          "patch_status": "approved"
        },
        {
          "severity": "Important",
          "patchname": "vcredist_x64_sp1.exe",
          "updated_time": "1704363395117",
          "update_type": "Security Updates",
          "patch_description": "Microsoft Visual C++ 2010        Service Pack 1 Redistributable Package MFC Security        Update",
          "kb_number": "2565063",
          "vendor_name": "Microsoft",
          "installed_system_count": 1,
          "supercededby": "NA",
          "patch_released_time": "1307989800000",
          "patch_supported_time": "1307989800000",
          "patch_size": "10274136",
          "patchid": "12622",
          "patch_uninstall": "not supported",
          "bulletinid": "MS11-025",
          "approveduser_first_name": "DC-SYSTEM-USER",
          "reboot_required": "may require",
          "platform_name": "Windows",
          "download_status": "--",
          "missing_system_count": 0,
          "failed_system_count": 0,
          "patch_status": "approved"
        }
      ]
    },
    "status": "success"
  }
                
▼ 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.