Retrieves the list of all Automated Patch Deployment (APD) tasks.
get /dcapi/patch/reports/apdTasks
https://{serverurl}/dcapi/patch/reports/apdTasks Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
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.
Name of the column in which the search value needs to be looked up. Use together with searchValue.
Text to look up in the column given in searchColumn. Use together with searchColumn.
Indicates whether the response is requested for the web console. Set to True to get the response in the format used by the web console; leave empty for the default API response.
Comma-separated list of column names that should be left out of the response, to get a lighter response with only the columns you need.
Name of the column in which the search value needs to be looked up. Use together with SEARCH_VALUE.
Text to look up in the column given in SEARCH_COLUMN. Use together with SEARCH_COLUMN.
View filter ID for saved custom view
Array of filter criteria for the report view
Column identifier for the filter criterion
Comparison operator (e.g., equals, contains, greater_than)
Custom comparator override for special filter logic
Logical operator to combine with next criterion (AND/OR)
curl --request GET \
--url https://appdomains/dcapi/patch/reports/apdTasks \
--header 'Accept: application/patchReports.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'content-type: application/json' \
--data '{}' {
"dcViewFilterID": 0,
"criteriaJSON": [
{
"columnID": 0,
"searchValue": [
"string"
],
"comparator": "string",
"customComparator": "string",
"logicalOperator": "string"
}
]
}
Pagination metadata
Total number of records matching the query
Array of APD task entries
APD task name
Transformed total target systems count
APD task ID
Transformed APD task name
OS platform name (Windows, Mac, Linux)
Collection ID associated with the task
Transformed name of the task creator
Transformed task ID or authorization status
Collection status code
Task last modified time in epoch milliseconds
Transformed deployment policy template ID, or --
Scheduler class ID, or null
Transformed remarks
Task creation time in epoch milliseconds
Name of the task creator
OS platform ID
Transformed OS platform name
Transformed name of the user who last modified the task
Total target systems count
Name of the user who last modified the task
Task type label key
Transformed task type label
User ID of the task creator
Formatted task last modified time
Deployment policy template ID
Task type code
Remarks or collection ID reference
Formatted task creation time
Total number of pages available
Pagination links for next and previous pages
URL for the next page of results, or null if on the last page
URL for the previous page of results, or null if on the first page
Operation result: success
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
Error code: INTERNAL_ERROR for server-side failures
Localized error description: dc.rest.api_internal_error
APD tasks list
{
"metadata": {
"limit": 25,
"page": 1
},
"totalRecords": "2",
"messageResponse": [
{
"task_name": "MyTask3",
"total_target_transform": "2",
"task_id": "310",
"task_name_transform": "MyTask2",
"os_platform_name": "Windows",
"collection_id": "302",
"first_name_transform": "admin",
"task_id_transform": "Not Authorized",
"collection_status": "4",
"task_modified_time": "1778828832922",
"template_id_transform": "--",
"scheduler_class_id": null,
"remarks_transform": "",
"task_creation_time": "1778828832922",
"first_name": "admin",
"os_platform_id": "1",
"os_platform_name_transform": "Windows",
"modifieduser_first_name_transform": "admin",
"total_target": "2",
"modifieduser_first_name": "admin",
"label": "dc.conf.conf_param.Auto_Install_FeaturePack",
"label_transform": "Auto Install Patch",
"user_id": "1",
"task_modified_time_transform": "May 15, 2026 12:36 PM",
"template_id": "2",
"task_type": "18",
"remarks": "302",
"task_creation_time_transform": "May 15, 2026 12:36 PM"
},
{
"task_name": "MyTask2",
"total_target_transform": "2",
"task_id": "309",
"task_name_transform": "MyTask2",
"os_platform_name": "Windows",
"collection_id": "301",
"first_name_transform": "admin",
"task_id_transform": "Not Authorized",
"collection_status": "3",
"task_modified_time": "1778828792217",
"template_id_transform": "--",
"scheduler_class_id": null,
"remarks_transform": "",
"task_creation_time": "1778828792217",
"first_name": "admin",
"os_platform_id": "1",
"os_platform_name_transform": "Windows",
"modifieduser_first_name_transform": "admin",
"total_target": "2",
"modifieduser_first_name": "admin",
"label": "dc.conf.conf_param.Auto_Install_Patch",
"label_transform": "Auto Install Patch",
"user_id": "1",
"task_modified_time_transform": "May 15, 2026 12:36 PM",
"template_id": "2",
"task_type": "18",
"remarks": "301",
"task_creation_time_transform": "May 15, 2026 12:36 PM"
}
],
"totalPages": 1,
"Links": {
"next": null,
"prev": null
},
"status": "success"
}
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"
}
Server-side error
{
"error_code": "INTERNAL_ERROR",
"error_description": "dc.rest.api_internal_error"
}
![]()
Duration: 1 minute | Threshold: 50 | 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.