Broker Promotion

Get

Retrieve Parallels RAS Connection Broker Auto Promotion Settings.

GET/api/BrokerAutoPromotion

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

enabledboolean

Whether Auto Promotion is enabled.

autoPromoteAfterMinsinteger (int32)

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

failbackEnabledboolean

Whether Failback is enabled.

replicateboolean

Whether Replicate is enabled.

Request

JavaScriptCurlPython

const response = await fetch('/api/BrokerAutoPromotion', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "enabled": false,
  "failbackEnabled": false,
  "replicate": false
}

Update

Modify Parallels RAS Auto Promotion Settings.

PUT/api/BrokerAutoPromotion

Query parameters

Body

application/json; api-version=1.0

Auto Promotion Settings.

enablednullable boolean

Whether Auto Promotion is enabled or not.

autoPromoteAfterMinsnullable integer (int32)

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

failbackEnablednullable boolean

Whether Failback is enabled or not.

replicatenullable boolean

Whether Replicate is enabled or not.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/BrokerAutoPromotion', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}