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

This API endpoint is deprecating soon

Endpoints

Request URL

https://{serverurl}/api/1.4/patch/viewconfig

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

searchvaluestringOptional
searchcolumnstringOptional
searchtypestringOptional
sortorderstringOptional
orderbystringOptional
pagelimitstringOptional

Number of records per page.

pageintegerOptional

Current page number for pagination.

customeridlongOptional
confignamestringOptional
configstatusfilterstringOptional

InProgress Draft,Executed,Suspended,Deployed,RetryInProgress,Expired

viewtypefilterstringOptional
configtypefilterintegerOptional
platformfilterstringOptional

Windows/Mac/Linux

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/1.4/patch/viewconfig \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
Show full

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

Possible HTTP Status Codes

200HTTP code

Sample Response: HTTP 200

Paginated list of deployment configurations with status

Copied!
  {
    "response_code": 200,
    "message_type": "viewconfig",
    "message_response": {
      "viewconfig": [
        {
          "statusimage": "images/status_executedfailed.gif",
          "collection.collection_name": "Peazip x64 - narun-win10",
          "collectionstatussummary.retry_inprogress_count": 0,
          "collectionstatussummary.total_target_count": 1,
          "collectionstatus.status": 15,
          "collectionstatussummary.not_applicable_count": 0,
          "statuslabel": "dc.db.config.status.draft_download_failed",
          "collectionstatussummary.yet_to_apply_count": 1,
          "os_platform_name": "Windows",
          "collection.modified_time": 1552902864870,
          "collection.is_deleted": false,
          "collection.collection_id": 23708,
          "collectionstatussummary.failed_count": 0,
          "collection.is_single_config": true,
          "configurationparams.label": "dc.conf.conf_param.Install_Patches",
          "collectionstatussummary.success_count": 0,
          "first_name": "admin",
          "collection.platform_id": 1
        }
      ],
      "total": 284,
      "limit": 25,
      "page": 1
    },
    "message_version": "1.0",
    "status": "success"
  }
                
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.