Retrieve Systems and Patch Details

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

Fetches a list of systems along with their corresponding patch details, with support for extensive filtering.

Request URL

https://{serverurl}/dcapi/threats/systemreport/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.

patch_idstringOptional

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

resource_idstringOptional

Filters systems based on the resource ID provided. Fetch from Get All Systems

patch_approval_statusstringOptional

Returns only the patches with the given approval status. (Applicable inputs: Approved, Unapproved)

deployment_statusstringOptional

Deployment status of the patch on the system

install_error_codestringOptional

Returns only the systems where patch installation failed with the given error code.

fqdn_namestringOptional

Returns only the systems with the given fully qualified domain name (FQDN).

installed_timestringOptional

Returns only the systems where the patch was installed at the given time, in epoch milliseconds.

pageLimitstringOptional

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

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/threats/systemreport/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 systemreport array

Show Sub-Attributes
systemreportJSON Array

Array of system report objects, each containing a resource_id and its patches

Show Sub-Attributes
JSON Object
Show Sub-Attributes
patchesJSON Array

Array of patch objects for this system

Show Sub-Attributes
JSON Object
Show Sub-Attributes
bulletinidstring

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

deployment_remarksstring

Deployment remarks, or -- if none

deployment_statusstring

Deployment status, or -- if not deployed

install_error_codestring

Installation error code, or -- if none

installed_timestring

Patch installation timestamp, or -- if not installed

patch_approval_statusstring

Approval status: approved, unapproved, declined

patch_descriptionstring

Full description of the patch

patch_idstring

Unique patch identifier

patch_released_timestring

Patch release timestamp in milliseconds since epoch

patch_statusstring

Patch status on this system: Missing, Failed, Installed

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

update_typestring

Patch type: Security Updates, Non-Security Updates, Third Party Updates, Definition Update, Service Packs

vendor_namestring

Vendor name (e.g., Microsoft, Lamantine Software)

resource_idstring

Unique resource identifier for the system

message_typestring

Response type identifier: systemreport

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": "1",
      "totalPages": 1,
      "links": {
        "next": null,
        "prev": null
      },
      "page": 1
    },
    "response_code": 200,
    "message_type": "systemreport",
    "message_response": {
      "systemreport": [
        {
          "patches": [
            {
              "severity": "Important",
              "patchname": "vcredist_x86_sp1.exe",
              "update_type": "Security Updates",
              "patch_id": "12621",
              "patch_description": "Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update",
              "vendor_name": "Microsoft",
              "install_error_code": "--",
              "fqdn_name": "WIN-HOST-02.example.com",
              "patch_released_time": "1307989800000",
              "bulletinid": "MS11-025",
              "reboot_required": "may require",
              "platform_name": "Windows",
              "installed_time": "--",
              "deployment_remarks": "--",
              "patch_status": "Installed",
              "patch_approval_status": "approved"
            },
            {
              "severity": "Important",
              "patchname": "vcredist_x64_sp1.exe",
              "update_type": "Security Updates",
              "patch_id": "12622",
              "patch_description": "Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC Security Update",
              "vendor_name": "Microsoft",
              "install_error_code": "--",
              "fqdn_name": "XXXXXX.ZZZZ.YYYY.COM",
              "patch_released_time": "1307989800000",
              "bulletinid": "MS11-025",
              "reboot_required": "may require",
              "platform_name": "Windows",
              "installed_time": "--",
              "deployment_remarks": "--",
              "patch_status": "Installed",
              "patch_approval_status": "approved"
            }
          ],
          "resource_id": "304"
        }
      ]
    },
    "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.