AutoUpgrade | Parallels REST API

Parallels REST API

SupportDocumentation

Get

get

Retrieve the Auto-upgrade settings of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the Auto-upgrade settings.

Responses

application/json; api-version=1.0

objectOptional

Auto-upgrade Settings

application/json; api-version=1.0

get

GET /api/RDS/HostPool/{id}/AutoUpgrade HTTP/1.1
Host: 
Accept: */*

{
  "enabled": true,
  "startDateTime": "2025-04-18T19:59:27.986Z",
  "drainModeDurationInSecs": 1,
  "forceLogoffSessions": true,
  "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"
  ],
  "messages": [
    {
      "id": 1,
      "enabled": true,
      "messageTitle": "text",
      "message": "text",
      "sendMsgSecs": 1,
      "sendMsgWhen": [
        "0 = Before",
        "1 = After"
      ]
    }
  ]
}

Update

put

Update the Auto-upgrade settings of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the Auto-upgrade settings.

Body

objectOptional

Modify the Auto-upgrade settings

Responses

application/json; api-version=1.0

put

PUT /api/RDS/HostPool/{id}/AutoUpgrade HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 2

{}

No content