Retrieve List of APD Tasks

Retrieves the list of all Automated Patch Deployment (APD) tasks.

Endpoints

get /dcapi/patch/reports/apdTasks

Copy full URL

Request URL

https://{server-hostname}:8383/dcapi/patch/reports/apdTasks

Scope

PatchMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/dcapi/patch/reports/apdTasks \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/dcapi/patch/reports/apdTasks"))
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

headers = { 'Authorization': " d92d4xxxxxxxxxxxxx15f52" }

conn.request("GET", "/dcapi/patch/reports/apdTasks", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://appDomain/dcapi/patch/reports/apdTasks"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/patch/reports/apdTasks' -Method GET -Headers $headers

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object

Hide Sub-Attributes

metadataJSON object

Pagination metadata

Show Sub-Attributes

limitstring

Number of records per page

pagestring

Current page number

totalRecordsstring

Total number of records matching the query

messageResponseJSON array

Array of APD task entries

Show Sub-Attributes

JSON object

Show Sub-Attributes

task_namestring

APD task name

total_target_transformstring

Transformed total target systems count

task_idstring

APD task ID

task_name_transformstring

Transformed APD task name

os_platform_namestring

OS platform name (Windows, Mac, Linux)

collection_idstring

Collection ID associated with the task

first_name_transformstring

Transformed name of the task creator

task_id_transformstring

Transformed task ID or authorization status

collection_statusstring

Collection status code

task_modified_timestring

Task last modified time in epoch milliseconds

template_id_transformstring

Transformed deployment policy template ID, or --

scheduler_class_idstring

Scheduler class ID, or null

remarks_transformstring

Transformed remarks

task_creation_timestring

Task creation time in epoch milliseconds

first_namestring

Name of the task creator

os_platform_idstring

OS platform ID

os_platform_name_transformstring

Transformed OS platform name

modifieduser_first_name_transformstring

Transformed name of the user who last modified the task

total_targetstring

Total target systems count

modifieduser_first_namestring

Name of the user who last modified the task

labelstring

Task type label key

label_transformstring

Transformed task type label

user_idstring

User ID of the task creator

task_modified_time_transformstring

Formatted task last modified time

template_idstring

Deployment policy template ID

task_typestring

Task type code

remarksstring

Remarks or collection ID reference

task_creation_time_transformstring

Formatted task creation time

totalPagesstring

Total number of pages available

LinksJSON object

Pagination links for next and previous pages

Show Sub-Attributes

nextstring

URL for the next page of results, or null if on the last page

prevstring

URL for the previous page of results, or null if on the first page

statusstring

Operation result: success

- HTTP code 500

Response Body - application/json

JSON object

Hide Sub-Attributes

error_codestring

Error code: INTERNAL_ERROR for server-side failures

error_descriptionstring

Localized error description: dc.rest.api_internal_error

Possible Response Codes

200HTTP code

500HTTP code

Sample Response: HTTP 200

APD tasks list

Copied!

  {
    "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"
  }

▼ Show full

Sample Response: HTTP 500

Server-side error

Copied!

  {
    "error_description": "dc.rest.api_internal_error",
    "error_code": "INTERNAL_ERROR"
  }

▼ Show full

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.