Retrieve Applicable Patches Across Managed Systems

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 all applicable patches across managed systems.

Request URL

https://{serverurl}/dcapi/patch/reports/applicablePatches

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

pageLimitintegerOptional

Number of records per page (default 25)

pageintegerOptional

Page number to retrieve (1-based)

searchColumnstringOptional

Column name to search within

searchValuestringOptional

Value to search for in the specified column

platformstringOptional

1: Windows, 2: Mac, 3: Linux (comma-separated)

domainstringOptional

Domain name filter

severitystringOptional

0: Unrated, 1: Low, 2: Moderate, 3: Important, 4: Critical (comma-separated)

branchOfficestringOptional

Branch office name filter

customGroupstringOptional

Custom group name filter

patchStatusstringOptional

201: Installed, 202: Missing, 203: Failed (comma-separated)

mobileViewstringOptional

Set True for mobile-optimized view

Sample Request

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

Response Parameters

- HTTP code 200

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

Array of report-specific data records

totalstring

Total number of records

pagestring

Current page number

pageLimitstring

Records per page

- 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

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Applicable patches report

Copied!
  {
    "total": 3921,
    "pageLimit": 25,
    "data": [
      {
        "patchName": "KB5034765",
        "severity": "Critical",
        "approvalStatus": "Approved",
        "patchId": 310521,
        "missingCount": 15,
        "installedCount": 85,
        "vendorName": "Microsoft",
        "platform": "Windows"
      }
    ],
    "page": 1
  }
                
Show full

Sample Response: HTTP 500

Server-side error

Copied!
  {
    "error_description": "dc.rest.api_internal_error",
    "error_code": "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.