Retrieves the configuration and status details of the specified power operation task Returns the configuration and status details of the specified scheduled power operation task, including task name, operation type, target computers, schedule, and current execution status.
Request URL https://{server-hostname}:8383/dcapi/tools/shutdown/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/shutdown/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/shutdown/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/shutdown/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/shutdown/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/shutdown/tasks/{taskId}' -Method GET -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes taskId long
Scheduled shutdown task unique identifier
operation integer
Operation type: 1=Shutdown, 2=Restart, 3=Logoff, 4=Lock, 5=Hibernate
operationStr string
Human-readable operation name
status string
Task status: Active, Suspended, Completed
platform integer
Target platform: 1=Windows, 2=macOS
shutdownMessage string
Message displayed to end users before the operation
shutdownTimeout integer
Timeout in seconds before the operation executes
postPoneEnabled boolean
Whether end users can postpone the operation
skipEnabled boolean
Whether end users can skip the operation
nextRunTime long
Next scheduled execution time (epoch)
targetCount integer
Number of target computers
Possible Response Codes Sample Response: HTTP 200 {
"postPoneEnabled": true,
"operationStr": "Shutdown",
"nextRunTime": 1711508400000,
"shutdownTimeout": 300,
"skipEnabled": false,
"taskName": "Nightly Shutdown",
"shutdownMessage": "System will shutdown in 5 minutes.",
"operation": 1,
"targetCount": 20,
"taskId": 5,
"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.