Messages | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Get

get

Retrieve an Auto-upgrade Message.

Path parameters

idinteger · int32required

The ID of the Auto-upgrade 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/VDI/HostPool/{id}/AutoUpgrade/Messages/{messageId}'

200

401

404

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

Success

Delete

delete

Delete an Auto-upgrade Message by ID.

Path parameters

idinteger · int32required

The ID of the Auto-upgrade setting for which to remove the message.

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/VDI/HostPool/{id}/AutoUpgrade/Messages/{messageId}'

204

401

404

No Content

List

get

Retrieve Auto-upgrade Message(s).

Path parameters

idinteger · int32required

The ID of the Auto-upgrade setting for which to retrieve the messages.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/AutoUpgrade/Messages'

200

401

404

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

Success

Create

post

Create an Auto-upgrade Message.

Path parameters

idinteger · int32required

The ID of the Auto-upgrade setting for which to create the message.

Body

Add a message to the Auto-upgrade message list

enabledbooleanoptional

Whether to enable or disable the message.

messageTitlestring | nullablerequired

The title of the message.

messagestring | nullablerequired

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

sendMsgSecsinteger · int32optional

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

sendMsgWhenstring · enumoptional

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.

Available options:

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/VDI/HostPool/{id}/AutoUpgrade/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

No Content

Created

Update

put

Update an Auto-upgrade Message.

Path parameters

idinteger · int32required

The ID of the Auto-upgrade setting for which to modify the message.

messageIdinteger · int32required

The ID of the message to modify.

Body

Modify a message within the Auto-upgrade message list

enabledboolean | nullableoptional

Whether to enable or disable the message.

messageTitlestring | nullableoptional

The title of the message.

messagestring | nullableoptional

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

sendMsgSecsinteger · int32 | nullableoptional

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

sendMsgWhenstring · enumoptional

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.

Available options:

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/VDI/HostPool/{id}/AutoUpgrade/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 Content