Retrieves the current Wake on LAN global configuration settings

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 Wake on LAN configuration including the UDP port, wait time, automatic settings detection flag, and platform enablement flags (Windows, macOS, Linux) along with OS platform details.

Endpoints

Request URL

https://{server-hostname}:8383/dcapi/tools/wol/settings

Scope

Tools.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/tools/wol/settings \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

UDP port used for Wake on LAN magic packets

waitTimeinteger

Wait time in seconds between retry attempts

enableWolAutoSettingsboolean

Whether automatic network settings detection is enabled

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "wolPort": 9,
    "linuxEnabled": false,
    "windowsEnabled": true,
    "enableWolAutoSettings": true,
    "waitTime": 3,
    "macEnabled": false
  }
                
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.