Retrieves settings used to configure on-demand (immediate) power operations

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

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://{serverurl}/dcapi/tools/shutdown/settings

Scope

DesktopCentralCloud.Tools.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

operationTypeintegerMandatory

Type of power operation to retrieve settings for. Accepted values: 2 (shutdown), 3 (restart)

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomains/dcapi/tools/shutdown/settings?operationType=SOME_INTEGER_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
operationTypeinteger

Operation type: 1=Shutdown, 2=Restart, 3=Logoff, 4=Lock, 5=Hibernate

shutdownMessagestring

Message displayed to end users before the operation executes

shutdownMessageTitlestring

Title of the end-user notification dialog

shutdownTimeoutinteger

Delay in seconds before the operation executes after the notification is shown

shutdownModeinteger

Execution mode: 1=Forced, 2=Graceful

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "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.