HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. fastWsFailover

Change active WebSocket failover mode

post
http://127.0.0.1:8080/fastWsFailover/mode/active

Updates the active WebSocket failover mode for appliance communication. This controls ping frequency, redirection timing, and idle timeout for WebSocket connections between the Orchestrator and appliances. Changing the mode triggers orchestration for all appliances and logs the action.

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

Request body containing the failover mode identifier to activate.

Request body for changing the active WebSocket failover mode. Requires READ_WRITE role.

string
enum
required

Single character identifier for the failover mode to activate. Valid values: 'a' (Disabled/Legacy - no failover, ping=-1), 'b' (Slow - 30s ping, 90s redirect, 180s idle), 'c' (Normal - 20s ping, 60s redirect, 120s idle), 'd' (Aggressive - 10s ping, 30s redirect, 60s idle).

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 12 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated about 12 hours ago

Did this page help you?