Updates the Wake on LAN global configuration settings

Saves the Wake on LAN global configuration including the WOL UDP port, wait time between retry attempts, and whether automatic settings detection is enabled. The 'actionCall' query parameter specifies the settings action type.

Endpoints

post /dcapi/tools/wol/settings

Copy full URL

Request URL

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

Scope

DesktopCentralCloud.Tools.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/wolSettings.v1+jsonCopied!

- Query Parameters

actionCallstringOptional

Specifies the WOL automation settings operation to perform. Accepted values: 'saveSettings' (persist updated automation settings), 'showSettings' (retrieve current automation setting values)

- Request Body

application/json

JSON Object

Hide Sub-Attributes

waitTimestringOptional

wolPortstringOptional

enableWolAutoSettingsbooleanOptional

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomains/dcapi/tools/wol/settings \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/wolSettings.v1+json' \
  --data '{}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/dcapi/tools/wol/settings"))
        .header("Content-Type", "application/wolSettings.v1+json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

payload = "{}"

headers = {
    'Content-Type': "application/wolSettings.v1+json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/dcapi/tools/wol/settings", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/wolSettings.v1+json");
    headersMap.put("Accept", "application/json");

    data=Map();

    response = invokeUrl
    [
        url: "https://appDomains/dcapi/tools/wol/settings"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/wolSettings.v1+json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/dcapi/tools/wol/settings' -Method POST -Headers $headers -ContentType 'application/wolSettings.v1+json' -Body '{}'

Sample Request Body

Copied!

  {
    "wolPort": 9,
    "enableWolAutoSettings": true,
    "waitTime": 5
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

statusstring

Result of the operation: success or failure

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!

  {
    "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.