Sends Wake on LAN magic packets to the specified offline computers immediately

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

Executes an immediate Wake on LAN operation by broadcasting UDP magic packets to the specified computers. Accepts a JSON body containing a list of resource IDs and the target platform. Only Windows computers are supported.

Request URL

https://{serverurl}/dcapi/tools/wol/tasks/executeWakeupNow

Scope

DesktopCentralCloud.Tools.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/WakeupNowInfo.v1+jsonapplication/WakeupNowInfo.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
resourceIDsJSON ArrayOptional
Show Sub-Attributes
string

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/tools/wol/tasks/executeWakeupNow \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/WakeupNowInfo.v1+json' \
  --data '{}'

Sample Request Body

Copied!
  {
    "resourceIDs": [
      101,
      202,
      303
    ]
  }
                
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": 3,
    "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.