Retrieves the edit-mode configuration details of the specified scheduled Wake on LAN task

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 configuration details of the specified Wake on LAN task in edit mode, including task name, target settings, schedule, and current status. Used to populate the edit task form.

Request URL

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

Scope

DesktopCentralCloud.Tools.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

taskIdstringMandatory

The unique identifier of the task

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/tools/wol/tasks/{taskId} \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Scheduled WOL task unique identifier

taskNamestring

User-defined task name

platforminteger

Target platform: 1=Windows

statusstring

Task status: Active, Suspended

scheduleTypestring

Schedule type: once, daily, weekly, monthly

nextRunTimelong

Next scheduled execution time (epoch)

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "nextRunTime": 1711425600000,
    "scheduleType": "daily",
    "targetValue": "Engineering",
    "taskName": "Morning WOL",
    "targetType": "CustomGroup",
    "taskId": 18,
    "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.