Retrieve Patch Deployment

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 patch deployment configurations along with their execution status.

Endpoint

Request URL

https://{serverurl}/api/1.4/patch/viewconfig 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.

confignamestringOptional

Returns only the patch deployment configurations whose name contains the given text.

configstatusfilterstringOptional

Returns only the deployment configurations with the given status. Accepted values: InProgress, Draft, Executed, Suspended, Deployed, RetryInProgress, Expired.

viewtypefilterstringOptional

Selects the view of deployment configurations to be returned, for example, configurations created by you or by all users.

configtypefilterintegerOptional

Returns only the deployment configurations of the given type, for example, install patch or uninstall patch configurations.

platformfilterstringOptional

Returns only the records of the given operating system platform. Accepted values: windows, mac, linux.

Sample Request

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

message_responseJSON Object

Paginated deployment configurations data

Show Sub-Attributes
viewconfigJSON Array

Array of deployment configuration objects

Show Sub-Attributes
JSON Object
Show Sub-Attributes
collection.collection_idlong

Unique collection identifier

collection.collection_namestring

Configuration/collection name

collection.platform_idstring

Platform ID: 1=Windows, 2=Mac, 3=Linux

os_platform_namestring

Platform name

collectionstatus.statusstring

Configuration status code

statuslabelstring

Human-readable status label

statusimagestring

Status icon image path

collectionstatussummary.total_target_countstring

Total target systems

collectionstatussummary.success_countstring

Systems where deployment succeeded

collectionstatussummary.failed_countstring

Systems where deployment failed

collectionstatussummary.yet_to_apply_countstring

Systems pending deployment

collectionstatussummary.not_applicable_countstring

Systems where patch is not applicable

collectionstatussummary.retry_inprogress_countstring

Systems where retry is in progress

collection.modified_timelong

Last modified timestamp

collection.is_deletedboolean

Whether the configuration is deleted

collection.is_single_configboolean

Whether it is a single configuration

first_namestring

Username of the configuration creator

configurationparams.labelstring

Configuration type label

totalstring

Total number of configurations

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

Copied!
  {
    "message_type": "viewconfig",
    "message_response": {
      "viewconfig": [
        {
          "statusimage": "images/status_executedfailed.gif",
          "configurationparams.config_id": 151,
          "collection.customer_id": 1,
          "configdata.config_data_id": 38717,
          "configstatusdefn.status_id": 15,
          "configdata.config_type": 1,
          "statuslabel": "dc.db.config.status.draft_download_failed",
          "collectionstatussummary.yet_to_apply_count": 1,
          "collection_id": 23708,
          "os_platform_name": "Windows",
          "collection.is_single_config": true,
          "first_name": "admin",
          "collection.platform_id": 1,
          "os_platform_id": 1,
          "collection.collection_name": "Peazip x64 - narun-win10",
          "collectionstatussummary.retry_inprogress_count": 0,
          "collection.show_in_view": true,
          "cfgdatatocollection.config_data_id": 38717,
          "collectionstatussummary.total_target_count": 1,
          "collectionstatus.status": 15,
          "collectionstatussummary.not_applicable_count": 0,
          "deletedby": "--",
          "collection.modified_time": 1552902864870,
          "collection.is_deleted": false,
          "collection.collection_id": 23708,
          "cfgdatatocollection.collection_id": 23708,
          "user_id": 1,
          "configuration.config_id": 151,
          "collectionstatussummary.failed_count": 0,
          "collectionstatussummary.status_count_desc": "Total Targets ( 1 ), Yet to Apply ( 1 )",
          "configurationparams.label": "dc.conf.conf_param.Install_Patches",
          "configurationparams.small_image_name": "images/install_windows_patch_big.png",
          "modifieduser.user_id": 1,
          "collectionstatussummary.success_count": 0,
          "modifieduser.first_name": "admin",
          "collectionstatus.collection_id": 23708,
          "deleted_time": "--",
          "dc_user_id": "--"
        }
      ],
      "total": 26,
      "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.