Parallels REST API

List

Retrieve Auto-upgrade Message(s).

get

/api/AVD/DefaultSettings/SingleSession/AutoUpgrade/Messages

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AVD/DefaultSettings/SingleSession/AutoUpgrade/Messages'

200

401

404

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

Success

Create

Create an Auto-upgrade Message.

post

/api/AVD/DefaultSettings/SingleSession/AutoUpgrade/Messages

Body

enabledboolean

Whether to enable or disable the message.

messageTitlenullable stringrequired

The title of the message.

messagenullable stringrequired

A message that should be sent to users before the job starts.

sendMsgSecsinteger int32

Time interval in seconds before the job starts when the message to users should be sent.

sendMsgWhenenum

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.

Options: 0 = Before,1 = After

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/AVD/DefaultSettings/SingleSession/AutoUpgrade/Messages' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{"messageTitle":"text","message":"text","sendMsgWhen":["0 = Before","1 = After"]}'

201

401

404

No body

Created

Get

Retrieve an Auto-upgrade Message.

get

/api/AVD/DefaultSettings/SingleSession/AutoUpgrade/Messages/{messageId}

Path parameters

messageIdinteger int32required

The ID of the message to retrieve.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AVD/DefaultSettings/SingleSession/AutoUpgrade/Messages/{messageId}'

200

401

404

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

Success

Update

Update an Auto-upgrade Message.

put

/api/AVD/DefaultSettings/SingleSession/AutoUpgrade/Messages/{messageId}

Path parameters

messageIdinteger int32required

The ID of the message to modify.

Body

enablednullable boolean

Whether to enable or disable the message.

messageTitlenullable string

The title of the message.

messagenullable string

A message that should be sent to users before the job starts.

sendMsgSecsnullable integer int32

Time interval in seconds before the job starts when the message to users should be sent.

sendMsgWhenenum

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.

Options: 0 = Before,1 = After

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/AVD/DefaultSettings/SingleSession/AutoUpgrade/Messages/{messageId}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{"sendMsgWhen":["0 = Before","1 = After"]}'

204

401

404

No body

No Content

Delete

Delete an Auto-upgrade Message by ID.

delete

/api/AVD/DefaultSettings/SingleSession/AutoUpgrade/Messages/{messageId}

Path parameters

messageIdinteger int32required

The ID of the message to remove.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/AVD/DefaultSettings/SingleSession/AutoUpgrade/Messages/{messageId}'

204

401

404

No body

No Content