Retrieve Missing Patches Across Managed Systems 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 a paginated list of patches that are missing (not installed) across managed systems, including severity, download status, and affected system counts.

This API endpoint is deprecating soon

View new endpoint   >

Request URL

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

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

loginidstringOptional
resource_idstringOptional

{resource_id} - Unique identifier of the computer

useridstringOptional
usernamestringOptional
ticketstringOptional
customerNamestringOptional
customernamestringOptional
residfilterintegerOptional

Filter computer with particular resource id

domainfilterstringOptional

Get domain list from api/1.4/desktop/serverproperties

branchofficefilterstringOptional

Get branch office list from api/1.4/desktop/serverproperties

remoteofficefilterstringOptional
customgroupfilterstringOptional

Get custom group list from api/1.4/desktop/serverproperties

livestatusfilterintegerOptional

1 - Live: System is working.
2 - Down: System is not working.
3 - Unknown: System status is not known.

platformfilterstringOptional
connidfilterstringOptional
pagestringOptional
pagelimitstringOptional
orderbystringOptional
sortorderstringOptional
sortcolumnstringOptional
searchtypestringOptional
searchcolumnstringOptional
searchvaluestringOptional
patchidstringOptional
residstringOptional

{resid} - Unique identifier of the computer

languagefilterintegerOptional
approvalstatusfilterintegerOptional
downloadstatusfilterintegerOptional
supercedestatusfilterintegerOptional
healthfilterintegerOptional
severityfilterintegerOptional
patchtypefilterintegerOptional
patchstatusfilterintegerOptional
agentinstallationstatusfilterintegerOptional
installstatusfilterintegerOptional

21: Yet to install (agent has not been installed).
22: Installed (agent is currently installed).
23: Uninstalled (agent has been removed).
24: Yet to uninstall (marked for uninstallation but not yet removed).
29: Installation failure (an error occurred during installation).

licensetypefilterintegerOptional

1: Commercial (used for business or paid purposes).
2: Non-commercial (used for personal or educational purposes).
0: Unidentified (license type not specified).

scanstatusfilterintegerOptional

-1: Not done scan has not started.
0: Failed scan failed.
1: In progress scan is ongoing.
2: Success scan completed successfully.

deploymentstatusfilterintegerOptional
configtypefilterintegerOptional
accesstypefilterintegerOptional

1: Allowed (access is permitted).
2: Prohibited (access is restricted).
0: Not assigned (no access configuration).

compliancestatusfilterintegerOptional

0: Under licensed (fewer licenses than required).
1: Over licensed (more licenses than needed).
2: In compliance (license usage matches availability).
3: Expired (license validity has ended).
-1: Not available (compliance data is missing).

complianceStatusFilterintegerOptional
bulletinidstringOptional
oscompatibilityfilterstringOptional

32-bit: For 32-bit operating systems.
64-bit: For 64-bit operating systems.

uninstallsupportfilterstringOptional

Yes: Supports uninstallation.
No: Does not support uninstallation.

installerformatfilterstringOptional

MSI: Installed via MSI installer.
EXE: Installed via EXE installer.

licensefilterstringOptional

Get License List from api/1.4/inventory/licenses?swid={softwareID} in license_id parameter inside message response

hardwaretypefilterstringOptional

Get hardware type list from api/1.4/inventory/filterparams

manufacturerfilterstringOptional

Get hardware manufacturer list from api/1.4/inventory/filterparams

osfilterstringOptional
vendorfilterstringOptional
policynamestringOptional
configstatusfilterstringOptional
viewtypefilterstringOptional
latestpatchesstringOptional
prohibitedswidstringOptional

unique identifier of the prohibited software

categoryfilterstringOptional
ticketidstringOptional

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/api/1.4/patch/missingpatches \
  --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: missingpatches

message_responseJSON Object

Paginated missing patches data

Show Sub-Attributes
totalstring

Total number of missing patches

missingpatchesJSON Array

Array of missing patch objects

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

missingstring

Count of systems where this patch is missing

failedstring

Count of systems where installation failed

platform_namestring

Platform name

update_namestring

Update category name

patch_released_timelong

Patch release timestamp

patch_norebootstring

Reboot: 0=Not Required, 1=Required

patch_uninstall_statusstring

Uninstall: 0=Not Supported, 1=Supported

patch_sizelong

Patch file size in bytes

vendor_namestring

Vendor name

superceded_bystring

Superseding patch ID, or NA

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

Paginated missing patches

Copied!
  {
    "message_type": "missingpatches",
    "message_response": {
      "total": 26,
      "missingpatches": [
        {
          "patch_id": 309232,
          "bulletin_id": "TU-058",
          "patch_name": "FileZilla_3.41.2_win32-setup.exe",
          "patch_description": "FileZilla Client (3.41.2)",
          "severity": 1,
          "missing": 5,
          "failed": 2,
          "platform_name": "Windows",
          "update_name": "Third Party Updates",
          "patch_released_time": 1552971857000,
          "patch_noreboot": 1,
          "patch_uninstall_status": 1,
          "patch_size": 7917152,
          "vendor_name": "Tim Kosse",
          "superceded_by": "NA"
        }
      ],
      "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.