Retrieves settings used to configure on-demand (immediate) power operations Returns the immediate shutdown or restart settings including the timeout duration, message title, shutdown message, and operation mode. Accepts an 'operationType' query parameter (2 or 3) to specify the type of operation (shutdown or restart).
Request URL https://{server-hostname}:8383/dcapi/tools/shutdown/settings
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
--url https://appdomain/dcapi/tools/shutdown/settings \
--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/settings"))
.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/settings", 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/settings"
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/settings' -Method GET -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes operationType integer
Operation type: 1=Shutdown, 2=Restart, 3=Logoff, 4=Lock, 5=Hibernate
shutdownMessage string
Message displayed to end users before the operation executes
shutdownMessageTitle string
Title of the end-user notification dialog
shutdownTimeout integer
Delay in seconds before the operation executes after the notification is shown
shutdownMode integer
Execution mode: 1=Forced, 2=Graceful
Possible Response Codes Sample Response: HTTP 200 {
"shutdownMessageTitle": "System Shutdown",
"shutdownTimeout": 300,
"operationType": 2,
"shutdownMessage": "System will shutdown for maintenance.",
"shutdownMode": 1
}
▼ 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.