Retrieves all patch deployment configurations along with their execution status.
https://{serverurl}/api/1.4/patch/viewconfig Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Text to look up in the column given in searchcolumn. Use together with searchtype and searchcolumn.
Name of the column (field) in the response in which the search text is looked up. Use together with searchtype and searchvalue.
Type of search to be performed on the column, for example, contains. Search is applied only when searchtype, searchcolumn and searchvalue are all provided.
Direction in which the records are sorted. Allowed values: ASC (ascending) and DESC (descending). Use together with orderby.
Name of the column (field) in the response by which the records are sorted. Use together with sortorder.
Number of records to be returned per page. Minimum 1, maximum 1000. Default is 25.
Page number of the result set to be returned. Minimum 1, maximum 100000. Default is 1.
Returns only the patch deployment configurations whose name contains the given text.
Returns only the deployment configurations with the given status. Accepted values: InProgress, Draft, Executed, Suspended, Deployed, RetryInProgress, Expired.
Selects the view of deployment configurations to be returned, for example, configurations created by you or by all users.
Returns only the deployment configurations of the given type, for example, install patch or uninstall patch configurations.
Returns only the records of the given operating system platform. Accepted values: windows, mac, linux.
curl --request GET \
--url https://appdomains/api/1.4/patch/viewconfig \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Value: viewconfig
Paginated deployment configurations data
Array of deployment configuration objects
Unique collection identifier
Configuration/collection name
Platform ID: 1=Windows, 2=Mac, 3=Linux
Platform name
Configuration status code
Human-readable status label
Status icon image path
Total target systems
Systems where deployment succeeded
Systems where deployment failed
Systems pending deployment
Systems where patch is not applicable
Systems where retry is in progress
Last modified timestamp
Whether the configuration is deleted
Whether it is a single configuration
Username of the configuration creator
Configuration type label
Total number of configurations
Records per page
Current page number
API version: 1.0
Operation status: success
Response code: 200
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
Message indicating insufficient privileges to access this resource
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
Rate limit exceeded message with retry guidance
{
"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
}
Authentication credentials are missing, expired or invalid
{
"error_code": "UAC_UNAUTHORIZED",
"error_description": "dc.rest.authentication.unauthorized"
}
Authenticated user lacks the required role or scope
{
"errorCode": "FORBIDDEN",
"errorMessage": "You do not have sufficient privileges to perform this operation"
}
API call threshold exceeded
{
"errorCode": "RATE_LIMIT_EXCEEDED",
"errorMessage": "API call limit exceeded. Retry after the lock period elapses"
}
![]()
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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.