# List APD Tasks Retrieves a paginated list of Automated Patch Deployment tasks with their configuration details, target counts, and schedule information. **This API endpoint is deprecating soon** ## Endpoint `GET /api/1.4/patch/apdTaskListdetails` ## Request ### Request URL https://[{serverurl}](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)/api/1.4/patch/apdTaskListdetails ### Scope `DesktopCentralCloud.PatchMgmt.READ` ### Header `Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52` ### Request Parameters #### Request Headers - **Accept** `string` — **Mandatory** - `application/json` #### Query Parameters - **customerid** `long` — Optional - Applicable only for MSP editions. A unique identifier of the customer on whom the action needs to be performed. Get the customer ID from the [Customer Details](https://www.manageengine.com/products/desktop-central/help/api/cloud/getallcustomers.html) API. ### Sample Request ```curl 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` - **message_type** `string` - Action identifier: apdTaskListdetails - **message_response** `JSON Object` - APD task list response payload with pagination - **message_version** `string` - API version: 1.3 - **status** `string` - Overall operation status: success ### HTTP Code 401 #### Response Body — `application/json` - `JSON Object` - **errorCode** `long` - Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required) - **errorMsg** `string` - Authentication failure reason ### HTTP Code 403 #### Response Body — `application/json` - `JSON Object` - **errorCode** `long` - Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin) - **errorMsg** `string` - Message indicating insufficient privileges to access this resource ### HTTP Code 429 #### Response Body — `application/json` - `JSON Object` - **errorCode** `long` - 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 - **errorMsg** `string` - Rate limit exceeded message with retry guidance ## Sample Responses ### HTTP 200 ```json { "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" } ``` ### HTTP 401 Authentication credentials are missing, expired, or invalid. ```json { "error_code": "UAC_UNAUTHORIZED", "error_description": "dc.rest.authentication.unauthorized" } ``` ### HTTP 403 Authenticated user lacks the required role or scope. ```json { "errorCode": "FORBIDDEN", "errorMessage": "You do not have sufficient privileges to perform this operation" } ``` ### HTTP 429 API call threshold exceeded. ```json { "errorCode": "RATE_LIMIT_EXCEEDED", "errorMessage": "API call limit exceeded. Retry after the lock period elapses" } ``` ## Rate Limits **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.