# Retrieves the default configuration required to create a new scheduled Wake on LAN task

Returns the default form values and configuration required to initialize the create-task form for a scheduled Wake on LAN task. Accepts an optional 'platform' query parameter to pre-filter platform-specific defaults.

## Endpoints

`GET /dcapi/tools/wol/tasks/ScheduledTask`

## Request

### Request URL

`https://{server-hostname}:8383/dcapi/tools/wol/tasks/ScheduledTask`

### Scope

`Tools.READ`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Accept** `string` **Mandatory**
  - `application/json`

### Sample Request

```curl
curl --request GET \
  --url https://appdomain/dcapi/tools/wol/tasks/ScheduledTask \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 200

#### Response Body — `application/json`

`JSON Object`

- **defaultTaskName** `string`
  - Auto-generated default task name prefilled in the WOL task creation form
- **platforms** `array`
  - Array of platform objects with id, name, and isEnabled flag
- **defaultWolPort** `integer`
  - Default UDP port used for Wake on LAN magic packets
- **defaultWaitTime** `integer`
  - Default wait time in seconds between WOL retry attempts

### Sample Response: HTTP 200

```json
{
  "defaultTaskName": "WOL Task - 25 Mar 2026",
  "defaultWaitTime": 3,
  "platforms": [
    {
      "isEnabled": true,
      "name": "Windows",
      "id": 1
    }
  ],
  "defaultWolPort": 9
}
```

### Possible Response Codes

- **200** — HTTP code

## Rate Limits

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**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.