Retrieves the default configuration required to create a new scheduled Wake on LAN task Returns the default form values and configuration required to initialize the create-task form for a scheduled Wake on LAN task. Accepts an optional 'platform' query parameter to pre-filter platform-specific defaults.
Request URL https://{server-hostname}:8383/dcapi/tools/wol/tasks/ScheduledTask
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
--url https://appdomain/dcapi/tools/wol/tasks/ScheduledTask \
--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/ScheduledTask"))
.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/ScheduledTask", 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/ScheduledTask"
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/ScheduledTask' -Method GET -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes defaultTaskName string
Auto-generated default task name prefilled in the WOL task creation form
platforms array
Array of platform objects with id, name, and isEnabled flag
defaultWolPort integer
Default UDP port used for Wake on LAN magic packets
defaultWaitTime integer
Default wait time in seconds between WOL retry attempts
Possible Response Codes Sample Response: HTTP 200 {
"defaultTaskName": "WOL Task - 25 Mar 2026",
"defaultWaitTime": 3,
"platforms": [
{
"isEnabled": true,
"name": "Windows",
"id": 1
}
],
"defaultWolPort": 9
}
▼ 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.