Schedule | Parallels REST API

Parallels REST API

Products Support Partners Documentation

List

get

Retrieve information about one or multiple Schedule setting.

Query parameters

SiteIdinteger · int32optional

Site ID from which to retrieve the Schedule setting (optional).

Namestringoptional

The name of the Schedule setting for which to retrieve the information. This must be the actual Schedule setting name used in the RAS connections.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Provider/VM/AVDHost/Schedule'

200

401

404

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-04-06T01:33:22.303Z",
    "timeLastMod": "2025-04-06T01:33:22.303Z",
    "siteID": 1,
    "objType": [
      "44 = RDS",
      "92 = AVD",
      "100 = VDI"
    ],
    "action": [
      "0 = Disable",
      "1 = Reboot",
      "3 = Startup",
      "4 = Shutdown",
      "7 = Recreate"
    ],
    "targetType": [
      "0 = Host",
      "1 = HostPool"
    ],
    "enabled": true,
    "name": "text",
    "description": "text",
    "type": 1,
    "targetIDs": [
      1
    ],
    "targetNativeHosts": [
      {
        "poolId": 1,
        "guid": "text",
        "guestName": "text",
        "hostAzureID": "text"
      }
    ],
    "trigger": {
      "startDateTime": "2025-04-06T01:33:22.303Z",
      "endDateTime": "2025-04-06T01:33:22.303Z",
      "repeat": [
        "0 = Never",
        "1 = EveryDay",
        "2 = EveryWeek",
        "3 = Every2Weeks",
        "4 = EveryMonth",
        "5 = EveryYear",
        "6 = SpecificDays"
      ],
      "specificDays": [
        "0 = Never",
        "1 = Sunday",
        "2 = Monday",
        "4 = Tuesday",
        "8 = Wednesday",
        "16 = Thursday",
        "32 = Friday",
        "64 = Saturday"
      ],
      "durationInSecs": 1,
      "completeIn": 1
    },
    "options": {
      "poolMembersType": 1,
      "percentageMembers": 1,
      "membersToStart": 1,
      "powerOnAssignedPoolMembers": 1,
      "messages": [
        {
          "id": 1,
          "enabled": true,
          "messageTitle": "text",
          "message": "text",
          "sendMsgSecs": 1,
          "sendMsgWhen": [
            "0 = Before",
            "1 = After"
          ]
        }
      ],
      "enableDrainMode": true,
      "forceServerRebootAfter": 1,
      "enforceScheduleInactiveHost": true,
      "onDisable": true
    }
  }
]

Success

Get

get

Retrieve information about a particular Schedule setting by ID.

Path parameters

Idinteger · int32required

The ID of the Schedule setting for which to retrieve the information.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Provider/VM/AVDHost/Schedule/{id}'

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:33:22.303Z",
  "timeLastMod": "2025-04-06T01:33:22.303Z",
  "siteID": 1,
  "objType": [
    "44 = RDS",
    "92 = AVD",
    "100 = VDI"
  ],
  "action": [
    "0 = Disable",
    "1 = Reboot",
    "3 = Startup",
    "4 = Shutdown",
    "7 = Recreate"
  ],
  "targetType": [
    "0 = Host",
    "1 = HostPool"
  ],
  "enabled": true,
  "name": "text",
  "description": "text",
  "type": 1,
  "targetIDs": [
    1
  ],
  "targetNativeHosts": [
    {
      "poolId": 1,
      "guid": "text",
      "guestName": "text",
      "hostAzureID": "text"
    }
  ],
  "trigger": {
    "startDateTime": "2025-04-06T01:33:22.303Z",
    "endDateTime": "2025-04-06T01:33:22.303Z",
    "repeat": [
      "0 = Never",
      "1 = EveryDay",
      "2 = EveryWeek",
      "3 = Every2Weeks",
      "4 = EveryMonth",
      "5 = EveryYear",
      "6 = SpecificDays"
    ],
    "specificDays": [
      "0 = Never",
      "1 = Sunday",
      "2 = Monday",
      "4 = Tuesday",
      "8 = Wednesday",
      "16 = Thursday",
      "32 = Friday",
      "64 = Saturday"
    ],
    "durationInSecs": 1,
    "completeIn": 1
  },
  "options": {
    "poolMembersType": 1,
    "percentageMembers": 1,
    "membersToStart": 1,
    "powerOnAssignedPoolMembers": 1,
    "messages": [
      {
        "id": 1,
        "enabled": true,
        "messageTitle": "text",
        "message": "text",
        "sendMsgSecs": 1,
        "sendMsgWhen": [
          "0 = Before",
          "1 = After"
        ]
      }
    ],
    "enableDrainMode": true,
    "forceServerRebootAfter": 1,
    "enforceScheduleInactiveHost": true,
    "onDisable": true
  }
}

Success

Delete

delete

Remove a Schedule setting.

Path parameters

Idinteger · int32required

The ID of a Schedule setting to remove.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/Provider/VM/AVDHost/Schedule/{id}'

204

401

404

No Content

Update

put

Modify properties of a Schedule setting.

Path parameters

idinteger · int32required

The ID of the Schedule setting to modify.

Body

newNamestring | nullableoptional

A new name for the scheduler job.

enabledboolean | nullableoptional

Whether to enable or disable the schedule.

descriptionstring | nullableoptional

Schedule description.

startDateTimestring · date-time | nullableoptional

Start time. Default: Now.

durationInSecsnumber · double | nullableoptional

Duration in seconds.

repeatstring · enumoptional

Repeat Type

Available options:

specificDaysstring[Flag] · enumoptional

Repeat Specific Days

Available options:

completeIninteger · int32 | nullableoptional

The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.

poolMembersTypeinteger · int32 | nullableoptional

Whether to select the percentage or specific number of members to be started

percentageMembersinteger · int32 | nullableoptional

Percentage of members to be started

membersToStartinteger · int32 | nullableoptional

Specific number of members to be started

powerOnAssignedPoolMembersinteger · int32 | nullableoptional

Power On Assigned Pool Members

enableDrainModeboolean | nullableoptional

Whether to enable Drain Mode

forceServerRebootAfterinteger · int32 | nullableoptional

Force server reboot after the specified time in seconds

enforceScheduleInactiveHostboolean | nullableoptional

Enforce schedule for currently inactive host

onDisableboolean | nullableoptional

What action to take on Disable

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/Provider/VM/AVDHost/Schedule/{id}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "newName": "text",
    "enabled": true,
    "description": "text",
    "startDateTime": "2025-04-06T01:33:22.303Z",
    "durationInSecs": 1,
    "repeat": [
      "0 = Never",
      "1 = EveryDay",
      "2 = EveryWeek",
      "3 = Every2Weeks",
      "4 = EveryMonth",
      "5 = EveryYear",
      "6 = SpecificDays"
    ],
    "specificDays": [
      "0 = Never",
      "1 = Sunday",
      "2 = Monday",
      "4 = Tuesday",
      "8 = Wednesday",
      "16 = Thursday",
      "32 = Friday",
      "64 = Saturday"
    ],
    "completeIn": 1,
    "poolMembersType": 1,
    "percentageMembers": 1,
    "membersToStart": 1,
    "powerOnAssignedPoolMembers": 1,
    "enableDrainMode": true,
    "forceServerRebootAfter": 1,
    "enforceScheduleInactiveHost": true,
    "onDisable": true
  }'

204

401

404

No Content

List

Get

Delete

Update

Cancel Schedule