List APD Tasks 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 a paginated list of Automated Patch Deployment tasks with their configuration details, target counts, and schedule information.

This API endpoint is deprecating soon

View new endpoint   >

Request URL

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

Scope

DesktopCentralCloud.PatchMgmt.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Sample Request

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

Action identifier: apdTaskListdetails

message_responseJSON Object

APD task list response payload with pagination

Show Sub-Attributes
totalstring

Total number of APD tasks

apdtasklistdetailsJSON Array

Array of APD task detail objects

Show Sub-Attributes
JSON Object
Show Sub-Attributes
task_namestring

APD task name

task_idstring

Unique task identifier

collection_idstring

Associated collection/group ID

collection_statusstring

Collection status (2=active)

task_typestring

Task type identifier (18=APD task)

os_platform_namestring

Target platform display name: Windows, Mac, or Linux

os_platform_idstring

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

total_targetstring

Number of target computers

user_idstring

User ID who created the task

first_namestring

First name of the user who created the task

task_creation_timestring

Task creation timestamp in epoch milliseconds

task_modified_timestring

Last modification timestamp in epoch milliseconds

scheduler_class_idstring

Scheduler class ID or -- if not scheduled

template_idstring

Deployment template ID or -- if not assigned

remarksstring

Remarks or collection ID reference

limitstring

Records per page

pagestring

Current page number

message_versionstring

API version: 1.3

statusstring

Overall 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": "apdTaskListdetails",
    "message_response": {
      "total": 2,
      "apdtasklistdetails": [
        {
          "task_name": "MyTask1",
          "total_target": "1",
          "task_id": "633",
          "os_platform_name": "Windows",
          "collection_id": "312",
          "collection_status": "2",
          "user_id": "1",
          "task_modified_time": "1756191374069",
          "scheduler_class_id": "--",
          "template_id": "--",
          "task_type": "18",
          "task_creation_time": "1756191374069",
          "first_name": "admin",
          "os_platform_id": "1",
          "remarks": "312"
        },
        {
          "task_name": "MyTask2",
          "total_target": "--",
          "task_id": "635",
          "os_platform_name": "Windows",
          "collection_id": "313",
          "collection_status": "2",
          "user_id": "1",
          "task_modified_time": "1756191413366",
          "scheduler_class_id": "--",
          "template_id": "--",
          "task_type": "18",
          "task_creation_time": "1756191413366",
          "first_name": "admin",
          "os_platform_id": "1",
          "remarks": "313"
        }
      ],
      "limit": 25,
      "page": 1
    },
    "message_version": "1.3",
    "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.