Executes an immediate power operation (shutdown, restart, logoff, lock) on the specified computers

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

Initiates an immediate power operation on the specified computers. Accepts a JSON body specifying the operation type (shutdown, restart, logoff, lock, hibernate), target computers, shutdown message, timeout, postpone or skip options, and targeted users for selective logoff.

Request URL

https://{serverurl}/dcapi/tools/shutdown/executeShutdownNow

Scope

DesktopCentralCloud.Tools.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/shutdownNowStatus.v1+jsonapplication/shutdownNowStatus.v1+jsonCopied!
Content-TypestringMandatory
application/shutdownNowParams.v1+jsonapplication/shutdownNowParams.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
computersJSON ArrayOptional
Show Sub-Attributes
string
modestringOptional
operationstringOptional
operationStrstringOptional
postPoneEnabledbooleanOptional
selectedUsersJSON ArrayOptional
Show Sub-Attributes
JSON Object
Show Sub-Attributes
resourceIDstringOptional
userNamestringOptional
shutdownMessagestringOptional
shutdownMessageTitlestringOptional
shutdownModestringOptional
shutdownTimeoutstringOptional
skipEnabledbooleanOptional
taskPlatformIDstringOptional
skipOrPostPonestringOptional
postPoneCountstringOptional

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomains/dcapi/tools/shutdown/executeShutdownNow \
  --header 'Accept: application/shutdownNowStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/shutdownNowParams.v1+json' \
  --data '{}'

Sample Request Body

Copied!
  {
    "mode": "immediate",
    "shutdownMessageTitle": "Shutdown Notice",
    "postPoneEnabled": false,
    "operationStr": "Shutdown",
    "shutdownTimeout": 60,
    "skipEnabled": false,
    "shutdownMessage": "Immediate maintenance shutdown.",
    "shutdownMode": 1,
    "taskPlatformID": 1,
    "operation": 1,
    "computers": [
      101,
      202
    ]
  }
                
Show full

Response Parameters

- HTTP code 200

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

Result of the trigger operation: success or failure

triggeredCountinteger

Number of devices for which the operation was successfully triggered

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "triggeredCount": 2,
    "status": "success"
  }
                
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.