Messages | Parallels REST API

Parallels REST API

SupportDocumentation

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

objectOptional

Schedule Message

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/AutoUpgrade/Messages/{messageId} HTTP/1.1
Host: 
Accept: */*

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

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

delete

DELETE /api/AVD/HostPool/{id}/AutoUpgrade/Messages/{messageId} HTTP/1.1
Host: 
Accept: */*

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

object[]Optional

Schedule Message

application/json; api-version=1.0

get

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

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

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

post

POST /api/AVD/HostPool/{id}/AutoUpgrade/Messages HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 112

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

No content

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

put

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

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

No content