Retrieve All Downloaded Patches 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

Retrieve the details of all downloaded patches.

This API endpoint is deprecating soon

View new endpoint   >

Request URL

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

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

searchvaluestringOptional

Text to look up in the column given in searchcolumn. Use together with searchtype and searchcolumn.

searchcolumnstringOptional

Name of the column (field) in the response in which the search text is looked up. Use together with searchtype and searchvalue.

searchtypestringOptional

Type of search to be performed on the column, for example, contains. Search is applied only when searchtype, searchcolumn and searchvalue are all provided.

sortorderstringOptional

Direction in which the records are sorted. Allowed values: ASC (ascending) and DESC (descending). Use together with orderby.

orderbystringOptional

Name of the column (field) in the response by which the records are sorted. Use together with sortorder.

pagelimitstringOptional

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.

Sample Request

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

message_responseJSON Object

Paginated downloaded patches data

Show Sub-Attributes
totalstring

Total number of downloaded patches

limitstring

Records per page

pagestring

Current page number

downloadedpatchesJSON Array

Array of downloaded 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

platform_namestring

Platform: Windows, Mac, or Linux

patch_typestring

Patch type code

patch_released_timelong

Patch release timestamp

patch_sizelong

Patch file size in bytes

download_statusstring

Download status: 221=Downloaded

download_timelong

Timestamp when patch was downloaded

superceded_bystring

Superseding patch ID, or NA

message_versionstring

API version: 1.4

statusstring

Operation status: 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!
  {
    "message_type": "downloadedpatches",
    "message_response": {
      "total": 2,
      "limit": 25,
      "page": 1,
      "downloadedpatches": [
        {
          "patch_download_status_label": "dc.common.SUCCESS",
          "download_time": 1757340476320,
          "patch.patchid": 1419469,
          "patch_lang": 0,
          "patch_language": 0,
          "patch_updated": 1757055628000,
          "download_remarks_args": "--",
          "os_language": 0,
          "bulletin_id": "BI-001",
          "platform": 1,
          "patch_download_status_image": "images/download_success.png",
          "patch_released_time": 1755541800000,
          "patch_size": 28887288,
          "download_status": 221,
          "platform_name": "Windows",
          "patch_type": 12,
          "patch_status": "--",
          "how_to_url": "--",
          "patch_id": 1419469,
          "patch_name": "sp162871.exe",
          "patch_description": "HP Firmware update - 8D8A System (01.02.04)",
          "oslanguage.i18n": "Multilingual",
          "superceded_by": "NA",
          "patch_supported_time": 1757054914810,
          "patchdetails.patchid": 1419469,
          "error_kb_url": "--",
          "patch_location_id": 3632425,
          "download_remarks": "desktopcentral.server.patchmgmt.patch_download_success",
          "pmpatchlocation.patchid": 1419469
        },
        {
          "patch_download_status_label": "dc.common.SUCCESS",
          "download_time": 1757340472509,
          "patch.patchid": 1419470,
          "patch_lang": 0,
          "patch_language": 0,
          "patch_updated": 1757055628000,
          "download_remarks_args": "--",
          "os_language": 0,
          "bulletin_id": "BI-001",
          "platform": 1,
          "patch_download_status_image": "images/download_success.png",
          "patch_released_time": 1755455400000,
          "patch_size": 33507056,
          "download_status": 221,
          "platform_name": "Windows",
          "patch_type": 12,
          "patch_status": "--",
          "how_to_url": "--",
          "patch_id": 1419470,
          "patch_name": "sp162858.exe",
          "patch_description": "HP Firmware update - 8D94 System (01.02.04)",
          "oslanguage.i18n": "Multilingual",
          "superceded_by": "NA",
          "patch_supported_time": 1757054915059,
          "patchdetails.patchid": 1419470,
          "error_kb_url": "--",
          "patch_location_id": 3632426,
          "download_remarks": "desktopcentral.server.patchmgmt.patch_download_success",
          "pmpatchlocation.patchid": 1419470
        }
      ]
    },
    "message_version": "1.4",
    "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.