Messages | Parallels REST API

Parallels REST API

SupportDocumentation

Was this helpful?

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/AVD/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

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/AVD/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 body

Created

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

200

401

404

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

Success

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

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/AVD/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 body

No Content

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

204

401

404

No body

No Content