Parallels REST API

Create Shutdown

Creates a new Shutdown Schedule.

post

/api/Provider/VM/AVDHost/Schedule/Shutdown

Body

namestring | nullablerequired

<para type="description">Schedule name.</para>

siteIdinteger · int32

<para type="description">Site ID from which to retrieve the schedule.</para>

enabledboolean | nullable

<para type="description">Whether to enable or disable the schedule.</para>

descriptionstring | nullable

<para type="description">Schedule description.</para>

typeinteger · int32 | nullable

<para type="description">Schedule type</para>

startDateTimestring · date-time

<para type="description">Start time. Default: Now.</para>

durationInSecsnumber · double | nullable

<para type="description">Duration in seconds.</para>

repeatstring · enum

<para type="synopsis">Repeat Type</para> <para type="description"></para>

Options: 0 = Never,1 = EveryDay,2 = EveryWeek,3 = Every2Weeks,4 = EveryMonth,5 = EveryYear,6 = SpecificDays

specificDaysstring[Flag] · enum

<para type="synopsis">Repeat Specific Days</para> <para type="description"></para>

Options: 0 = Never,1 = Sunday,2 = Monday,4 = Tuesday,8 = Wednesday,16 = Thursday,32 = Friday,64 = Saturday

completeIninteger · int32 | nullable

<para type="description">The duration of the scheduler task in minutes. </para> <para type="description">Default: 15 minutes for disable task, 10 minutes for reboot task.</para>

poolMembersTypeinteger · int32 | nullable

<para type="description">Whether to select the percentage or specific number of members to be started</para>

percentageMembersinteger · int32 | nullable

<para type="description">Percentage of members to be started</para>

membersToStartinteger · int32 | nullable

<para type="description">Specific number of members to be started</para>

powerOnAssignedPoolMembersinteger · int32 | nullable

<para type="description">Power On Assigned Pool Members</para>

enableDrainModeboolean | nullable

<para type="description">Whether to enable Drain Mode</para>

forceServerRebootAfterinteger · int32 | nullable

<para type="description">Force server reboot after the specified time in seconds</para>

enforceScheduleInactiveHostboolean | nullable

<para type="description">Enforce schedule for currently inactive host</para>

onDisableboolean | nullable

<para type="description">What action to take on Disable</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Provider/VM/AVDHost/Schedule/Shutdown' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "siteId": 1,
    "enabled": true,
    "description": "text",
    "type": 1,
    "startDateTime": "2025-03-16T20:32:15.534Z",
    "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
  }'

200

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-16T20:32:15.534Z",
  "timeLastMod": "2025-03-16T20:32:15.534Z",
  "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-03-16T20:32:15.534Z",
    "endDateTime": "2025-03-16T20:32:15.534Z",
    "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

Create Startup

Creates a new Startup Schedule.

post

/api/Provider/VM/AVDHost/Schedule/Startup

Body

namestring | nullablerequired

<para type="description">Schedule name.</para>

siteIdinteger · int32

<para type="description">Site ID from which to retrieve the schedule.</para>

enabledboolean | nullable

<para type="description">Whether to enable or disable the schedule.</para>

descriptionstring | nullable

<para type="description">Schedule description.</para>

typeinteger · int32 | nullable

<para type="description">Schedule type</para>

startDateTimestring · date-time

<para type="description">Start time. Default: Now.</para>

durationInSecsnumber · double | nullable

<para type="description">Duration in seconds.</para>

repeatstring · enum

<para type="synopsis">Repeat Type</para> <para type="description"></para>

Options: 0 = Never,1 = EveryDay,2 = EveryWeek,3 = Every2Weeks,4 = EveryMonth,5 = EveryYear,6 = SpecificDays

specificDaysstring[Flag] · enum

<para type="synopsis">Repeat Specific Days</para> <para type="description"></para>

Options: 0 = Never,1 = Sunday,2 = Monday,4 = Tuesday,8 = Wednesday,16 = Thursday,32 = Friday,64 = Saturday

completeIninteger · int32 | nullable

<para type="description">The duration of the scheduler task in minutes. </para> <para type="description">Default: 15 minutes for disable task, 10 minutes for reboot task.</para>

poolMembersTypeinteger · int32 | nullable

<para type="description">Whether to select the percentage or specific number of members to be started</para>

percentageMembersinteger · int32 | nullable

<para type="description">Percentage of members to be started</para>

membersToStartinteger · int32 | nullable

<para type="description">Specific number of members to be started</para>

powerOnAssignedPoolMembersinteger · int32 | nullable

<para type="description">Power On Assigned Pool Members</para>

enableDrainModeboolean | nullable

<para type="description">Whether to enable Drain Mode</para>

forceServerRebootAfterinteger · int32 | nullable

<para type="description">Force server reboot after the specified time in seconds</para>

enforceScheduleInactiveHostboolean | nullable

<para type="description">Enforce schedule for currently inactive host</para>

onDisableboolean | nullable

<para type="description">What action to take on Disable</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Provider/VM/AVDHost/Schedule/Startup' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "siteId": 1,
    "enabled": true,
    "description": "text",
    "type": 1,
    "startDateTime": "2025-03-16T20:32:15.534Z",
    "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
  }'

200

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-16T20:32:15.534Z",
  "timeLastMod": "2025-03-16T20:32:15.534Z",
  "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-03-16T20:32:15.534Z",
    "endDateTime": "2025-03-16T20:32:15.534Z",
    "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

Create Disable

Creates a new disable Schedule.

post

/api/Provider/VM/AVDHost/Schedule/Disable

Body

namestring | nullablerequired

<para type="description">Schedule name.</para>

siteIdinteger · int32

<para type="description">Site ID from which to retrieve the schedule.</para>

enabledboolean | nullable

<para type="description">Whether to enable or disable the schedule.</para>

descriptionstring | nullable

<para type="description">Schedule description.</para>

typeinteger · int32 | nullable

<para type="description">Schedule type</para>

startDateTimestring · date-time

<para type="description">Start time. Default: Now.</para>

durationInSecsnumber · double | nullable

<para type="description">Duration in seconds.</para>

repeatstring · enum

<para type="synopsis">Repeat Type</para> <para type="description"></para>

Options: 0 = Never,1 = EveryDay,2 = EveryWeek,3 = Every2Weeks,4 = EveryMonth,5 = EveryYear,6 = SpecificDays

specificDaysstring[Flag] · enum

<para type="synopsis">Repeat Specific Days</para> <para type="description"></para>

Options: 0 = Never,1 = Sunday,2 = Monday,4 = Tuesday,8 = Wednesday,16 = Thursday,32 = Friday,64 = Saturday

completeIninteger · int32 | nullable

<para type="description">The duration of the scheduler task in minutes. </para> <para type="description">Default: 15 minutes for disable task, 10 minutes for reboot task.</para>

poolMembersTypeinteger · int32 | nullable

<para type="description">Whether to select the percentage or specific number of members to be started</para>

percentageMembersinteger · int32 | nullable

<para type="description">Percentage of members to be started</para>

membersToStartinteger · int32 | nullable

<para type="description">Specific number of members to be started</para>

powerOnAssignedPoolMembersinteger · int32 | nullable

<para type="description">Power On Assigned Pool Members</para>

enableDrainModeboolean | nullable

<para type="description">Whether to enable Drain Mode</para>

forceServerRebootAfterinteger · int32 | nullable

<para type="description">Force server reboot after the specified time in seconds</para>

enforceScheduleInactiveHostboolean | nullable

<para type="description">Enforce schedule for currently inactive host</para>

onDisableboolean | nullable

<para type="description">What action to take on Disable</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Provider/VM/AVDHost/Schedule/Disable' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "siteId": 1,
    "enabled": true,
    "description": "text",
    "type": 1,
    "startDateTime": "2025-03-16T20:32:15.534Z",
    "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
  }'

200

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-16T20:32:15.534Z",
  "timeLastMod": "2025-03-16T20:32:15.534Z",
  "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-03-16T20:32:15.534Z",
    "endDateTime": "2025-03-16T20:32:15.534Z",
    "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

Create Reboot

Creates a new Reboot Schedule.

post

/api/Provider/VM/AVDHost/Schedule/Reboot

Body

namestring | nullablerequired

<para type="description">Schedule name.</para>

siteIdinteger · int32

<para type="description">Site ID from which to retrieve the schedule.</para>

enabledboolean | nullable

<para type="description">Whether to enable or disable the schedule.</para>

descriptionstring | nullable

<para type="description">Schedule description.</para>

typeinteger · int32 | nullable

<para type="description">Schedule type</para>

startDateTimestring · date-time

<para type="description">Start time. Default: Now.</para>

durationInSecsnumber · double | nullable

<para type="description">Duration in seconds.</para>

repeatstring · enum

<para type="synopsis">Repeat Type</para> <para type="description"></para>

Options: 0 = Never,1 = EveryDay,2 = EveryWeek,3 = Every2Weeks,4 = EveryMonth,5 = EveryYear,6 = SpecificDays

specificDaysstring[Flag] · enum

<para type="synopsis">Repeat Specific Days</para> <para type="description"></para>

Options: 0 = Never,1 = Sunday,2 = Monday,4 = Tuesday,8 = Wednesday,16 = Thursday,32 = Friday,64 = Saturday

completeIninteger · int32 | nullable

<para type="description">The duration of the scheduler task in minutes. </para> <para type="description">Default: 15 minutes for disable task, 10 minutes for reboot task.</para>

poolMembersTypeinteger · int32 | nullable

<para type="description">Whether to select the percentage or specific number of members to be started</para>

percentageMembersinteger · int32 | nullable

<para type="description">Percentage of members to be started</para>

membersToStartinteger · int32 | nullable

<para type="description">Specific number of members to be started</para>

powerOnAssignedPoolMembersinteger · int32 | nullable

<para type="description">Power On Assigned Pool Members</para>

enableDrainModeboolean | nullable

<para type="description">Whether to enable Drain Mode</para>

forceServerRebootAfterinteger · int32 | nullable

<para type="description">Force server reboot after the specified time in seconds</para>

enforceScheduleInactiveHostboolean | nullable

<para type="description">Enforce schedule for currently inactive host</para>

onDisableboolean | nullable

<para type="description">What action to take on Disable</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Provider/VM/AVDHost/Schedule/Reboot' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "siteId": 1,
    "enabled": true,
    "description": "text",
    "type": 1,
    "startDateTime": "2025-03-16T20:32:15.534Z",
    "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
  }'

200

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-16T20:32:15.534Z",
  "timeLastMod": "2025-03-16T20:32:15.534Z",
  "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-03-16T20:32:15.534Z",
    "endDateTime": "2025-03-16T20:32:15.534Z",
    "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

List

Retrieve information about one or multiple Schedule setting.

get

/api/Provider/VM/AVDHost/Schedule

Query parameters

SiteIdinteger · int32

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

Namestring

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-03-16T20:32:15.534Z",
    "timeLastMod": "2025-03-16T20:32:15.534Z",
    "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-03-16T20:32:15.534Z",
      "endDateTime": "2025-03-16T20:32:15.534Z",
      "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

Retrieve information about a particular Schedule setting by ID.

get

/api/Provider/VM/AVDHost/Schedule/{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-03-16T20:32:15.534Z",
  "timeLastMod": "2025-03-16T20:32:15.534Z",
  "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-03-16T20:32:15.534Z",
    "endDateTime": "2025-03-16T20:32:15.534Z",
    "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

Update

Modify properties of a Schedule setting.

put

/api/Provider/VM/AVDHost/Schedule/{id}

Path parameters

idinteger · int32required

The ID of the Schedule setting to modify.

Body

newNamestring | nullable

<para type="description">A new name for the scheduler job.</para>

enabledboolean | nullable

<para type="description">Whether to enable or disable the schedule.</para>

descriptionstring | nullable

<para type="description">Schedule description.</para>

startDateTimestring · date-time | nullable

<para type="description">Start time. Default: Now.</para>

durationInSecsnumber · double | nullable

<para type="description">Duration in seconds.</para>

repeatstring · enum

<para type="synopsis">Repeat Type</para> <para type="description"></para>

Options: 0 = Never,1 = EveryDay,2 = EveryWeek,3 = Every2Weeks,4 = EveryMonth,5 = EveryYear,6 = SpecificDays

specificDaysstring[Flag] · enum

<para type="synopsis">Repeat Specific Days</para> <para type="description"></para>

Options: 0 = Never,1 = Sunday,2 = Monday,4 = Tuesday,8 = Wednesday,16 = Thursday,32 = Friday,64 = Saturday

completeIninteger · int32 | nullable

<para type="description">The duration of the scheduler task in minutes. </para> <para type="description">Default: 15 minutes for disable task, 10 minutes for reboot task.</para>

poolMembersTypeinteger · int32 | nullable

<para type="description">Whether to select the percentage or specific number of members to be started</para>

percentageMembersinteger · int32 | nullable

<para type="description">Percentage of members to be started</para>

membersToStartinteger · int32 | nullable

<para type="description">Specific number of members to be started</para>

powerOnAssignedPoolMembersinteger · int32 | nullable

<para type="description">Power On Assigned Pool Members</para>

enableDrainModeboolean | nullable

<para type="description">Whether to enable Drain Mode</para>

forceServerRebootAfterinteger · int32 | nullable

<para type="description">Force server reboot after the specified time in seconds</para>

enforceScheduleInactiveHostboolean | nullable

<para type="description">Enforce schedule for currently inactive host</para>

onDisableboolean | nullable

<para type="description">What action to take on Disable</para>

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-03-16T20:32:15.534Z",
    "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 body

No Content

Create

Create a Schedule Message.

post

/api/Provider/VM/AVDHost/Schedule/{id}/Messages

Path parameters

idinteger · int32required

The ID of the Schedule setting for which to create the message.

Body

enabledboolean

<para type="description">Whether to enable or disable the message.</para>

messageTitlestring | nullablerequired

<para type="description">The title of the message.</para>

messagestring | nullablerequired

<para type="description">A message that should be sent to users before the job starts.</para>

sendMsgSecsinteger · int32

<para type="description">Time interval in seconds before the job starts when the message to users should be sent.</para>

sendMsgWhenstring · enum

<para type="synopsis">Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.</para> <para type="description"></para>

Options: 0 = Before,1 = After

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Provider/VM/AVDHost/Schedule/{id}/Messages' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "enabled": true,
    "messageTitle": "text",
    "message": "text",
    "sendMsgSecs": 1,
    "sendMsgWhen": [
      "0 = Before",
      "1 = After"
    ]
  }'

201

401

404

{
  "id": 1,
  "enabled": true,
  "messageTitle": "text",
  "message": "text",
  "sendMsgSecs": 1,
  "sendMsgWhen": [
    "0 = Before",
    "1 = After"
  ]
}

Created

Get

Retrieve a Schedule Message.

get

/api/Provider/VM/AVDHost/Schedule/{id}/Messages/{messageId}

Path parameters

idinteger · int32required

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

messageIdinteger · int32required

The ID of the message to retrieve.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

200

401

404

{
  "id": 1,
  "enabled": true,
  "messageTitle": "text",
  "message": "text",
  "sendMsgSecs": 1,
  "sendMsgWhen": [
    "0 = Before",
    "1 = After"
  ]
}

Success

Update

Update a Schedule Message.

put

/api/Provider/VM/AVDHost/Schedule/{id}/Messages/{messageId}

Path parameters

idinteger · int32required

The ID of the Schedule setting for which to modify the message.

messageIdinteger · int32required

The ID of the message to modify.

Body

enabledboolean | nullable

<para type="description">Whether to enable or disable the message.</para>

messageTitlestring | nullable

<para type="description">The title of the message.</para>

messagestring | nullable

<para type="description">A message that should be sent to users before the job starts.</para>

sendMsgSecsinteger · int32 | nullable

<para type="description">Time interval in seconds before the job starts when the message to users should be sent.</para>

sendMsgWhenstring · enum

<para type="synopsis">Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.</para> <para type="description"></para>

Options: 0 = Before,1 = After

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/Provider/VM/AVDHost/Schedule/{id}/Messages/{messageId}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "enabled": true,
    "messageTitle": "text",
    "message": "text",
    "sendMsgSecs": 1,
    "sendMsgWhen": [
      "0 = Before",
      "1 = After"
    ]
  }'

204

401

404

No body

No Content

Add

Add a Schedule target setting.

post

/api/Provider/VM/AVDHost/Schedule/{id}/Target

Path parameters

Idinteger · int32required

The ID of the Schedule setting to modify.

Body

poolIdinteger · int32required

guidstring | nullable

guestNamestring | nullable

<para type="synopsis">Guest Name</para> <para type="description"></para>

hostAzureIDstring | nullable

<para type="synopsis">Host Azure ID</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Provider/VM/AVDHost/Schedule/{id}/Target' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "poolId": 1,
    "guid": "text",
    "guestName": "text",
    "hostAzureID": "text"
  }'

201

401

409

No body

Created

Delete

Remove a Schedule target setting.

delete

/api/Provider/VM/AVDHost/Schedule/{id}/Target

Path parameters

Idinteger · int32required

The ID of a Schedule setting to remove.

Body

poolIdinteger · int32required

guidstring | nullable

guestNamestring | nullable

<para type="synopsis">Guest Name</para> <para type="description"></para>

hostAzureIDstring | nullable

<para type="synopsis">Host Azure ID</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/Provider/VM/AVDHost/Schedule/{id}/Target' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "poolId": 1,
    "guid": "text",
    "guestName": "text",
    "hostAzureID": "text"
  }'

204

401

404

No body

No Content