Broker Promotion

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

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

HTTPcURLJavaScriptPython

GET /api/BrokerAutoPromotion HTTP/1.1
Host: 
Accept: */*

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

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.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

HTTPcURLJavaScriptPython

PUT /api/BrokerAutoPromotion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 81

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

No content