Broker Promotion | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Get

get

Retrieve Parallels RAS Connection Broker Auto Promotion Settings.

Query parameters

siteIdinteger · int32optional

The Site ID for which to retrieve the Parallels RAS Connection Broker Auto Promotion settings. (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/BrokerAutoPromotion'

200

401

404

{
  "enabled": true,
  "autoPromoteAfterMins": 1,
  "failbackEnabled": true,
  "replicate": true
}

Success

Update

put

Modify Parallels RAS Auto Promotion Settings.

Query parameters

siteIdinteger · int32optional

The Site ID for which to modify the Parallels RAS Auto Promotion Settings. (optional)

Body

enabledboolean | nullableoptional

Whether Auto Promotion is enabled or not.

autoPromoteAfterMinsinteger · int32 | nullableoptional

The amount of time (in mins) required to enable auto promotion.

failbackEnabledboolean | nullableoptional

Whether Failback is enabled or not.

replicateboolean | nullableoptional

Whether Replicate is enabled or not.