Retrieves available target options for scheduling a 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 available target groups, computers, or custom groups that can be selected when scheduling a Wake on LAN task. Accepts 'platform' and 'isDetailView' query parameters for filtering and detail level.

Request URL

https://{serverurl}/dcapi/tools/wol/targetDetails

Scope

DesktopCentralCloud.Tools.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

platformstringMandatory

Platform filter to scope available WOL targets. Accepted values: 1 (Windows), 2 (macOS), 3 (Linux)

isDetailViewbooleanOptional

Set to true to return full target details including computer counts; false returns a summary list

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomains/dcapi/tools/wol/targetDetails?platform=SOME_STRING_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Array of target objects with targetType (CustomGroup/Domain), targetName, targetId, and computerCount

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "targets": [
      {
        "computerCount": 40,
        "targetName": "Engineering",
        "targetId": 1,
        "targetType": "CustomGroup"
      },
      {
        "computerCount": 85,
        "targetName": "CORP",
        "targetId": 0,
        "targetType": "Domain"
      }
    ]
  }
                
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.