Delete an APD Task Deprecating soon Deleting a APD task.
This API endpoint is deprecating soon
Request URL https://{server-hostname}:8383/api/1.4/patch/deleteAPDTask
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
- Request Body application/json Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
--url https://appdomain/api/1.4/patch/deleteAPDTask \
--header 'Authorization: d92d4xxxxxxxxxxxxx15f52' \
--header 'content-type: application/json' \
--data '{"taskname":"windows create task"}'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/api/1.4/patch/deleteAPDTask"))
.header("content-type", "application/json")
.header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"taskname\":\"windows create task\"}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("appdomain")
payload = "{\"taskname\":\"windows create task\"}"
headers = {
'content-type': "application/json",
'Authorization': " d92d4xxxxxxxxxxxxx15f52"
}
conn.request("POST", "/api/1.4/patch/deleteAPDTask", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
headersMap = Map();
headersMap.put("Content-Type", "application/json");
headersMap.put("Accept", "application/json");
data=Map();
data.put("taskname","value");
response = invokeUrl
[
url: "https://appDomain/api/1.4/patch/deleteAPDTask"
type: POST
headers: headersMap
body: data
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("content-type", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/1.4/patch/deleteAPDTask' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"taskname":"windows create task"}'▼ Show full
Sample Request Body Delete an APD Task by name
Copied!
{
"taskname": "windows create task"
}
▼ Show full
Response Parameters - HTTP code 200 Response Body - application/json JSON object
Hide Sub-Attributes message_type string
Action identifier: deleteAPDTask
message_response JSON object
Show Sub-Attributes deleteapdtask JSON object
Show Sub-Attributes status string
Action result message (e.g., task has been deleted/resumed/suspended/modified successfully)
status string
Overall operation status: success
- HTTP code 400 Response Body - application/json JSON object
Hide Sub-Attributes error_code string
Error code: APD_TASK_NOT_FOUND for task name mismatch, APD_ACTION_FAILED for action failures
error string
Error type: APD_TASK_NOT_FOUND or APD_ACTION_FAILED
error_description string
Detailed failure reason: task not found, task already in target state, or insufficient permissions
Possible Response Codes Sample Response: HTTP 200 APD task deleted successfully
Copied!
{
"message_type": "deleteAPDTask",
"message_response": {
"deleteapdtask": {
"status": "Task has been deleted successfully"
}
},
"message_version": "1.4",
"status": "success"
}
▼ Show full
Sample Response: HTTP 400 APD task with the given name does not exist
Copied!
{
"error_description": "The specified APD task was not found",
"error_code": "APD_TASK_NOT_FOUND",
"error": "APD_TASK_NOT_FOUND"
}
▼ 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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.