Set failover role

Set the failover role of an appliance to either primary or backup.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The role to assign to the appliance.

Allowed:
boolean
Defaults to false

To perform a data sync with the peer appliance before failing over, set this to true. All users on the existing primary appliance will be disconnected during the data sync, and no other operations will be available until the swap is complete.

To fail over without a final data sync, set this to false or omit this field.

boolean
Defaults to false

This option is only applicable when contacting the primary appliance and attempting to set its role to "backup".

If this is set to true, then this appliance will become the backup even if the peer appliance cannot be contacted.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.