Retrieves the edit-mode configuration details of the specified scheduled Wake on LAN task Returns the configuration details of the specified Wake on LAN task in edit mode, including task name, target settings, schedule, and current status. Used to populate the edit task form.
Request URL https://{server-hostname}:8383/dcapi/tools/wol/tasks/{taskId}
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers - Path Parameters taskId string Mandatory
The unique identifier of the task
Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
--url https://appdomain/dcapi/tools/wol/tasks/{taskId} \
--header 'Accept: application/json' \
--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/tools/wol/tasks/{taskId}"))
.header("Accept", "application/json")
.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 = {
'Accept': "application/json",
'Authorization': " d92d4xxxxxxxxxxxxx15f52"
}
conn.request("GET", "/dcapi/tools/wol/tasks/{taskId}", 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/tools/wol/tasks/{taskId}"
type: GET
headers: headersMap
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/tools/wol/tasks/{taskId}' -Method GET -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes taskId long
Scheduled WOL task unique identifier
platform integer
Target platform: 1=Windows
status string
Task status: Active, Suspended
scheduleType string
Schedule type: once, daily, weekly, monthly
nextRunTime long
Next scheduled execution time (epoch)
Possible Response Codes Sample Response: HTTP 200 {
"nextRunTime": 1711425600000,
"scheduleType": "daily",
"targetValue": "Engineering",
"taskName": "Morning WOL",
"targetType": "CustomGroup",
"taskId": 18,
"platform": 1,
"status": "Active"
}
▼ 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.