Backup Handler API - Get | Pixotope Help Center

Backup State

Endpoints for reading the current backup activation state of this machine.

BackupActive [GET]

BackupActive

Returns the current backup activation state of this machine. The response includes whether backup mode is active, the hostname of this backup node, and whether the main server info requires a refresh. This value is also re-broadcast automatically whenever backup state changes via `ToggleBackupMode`.

Wire format: [Topic, Message]

Send: GetTopic + {} → Receive: UpdateTopic (targeted) + {Value: ...}

No parameters — message is always {}.

Value

Value.Active	boolean	Whether backup mode is currently active.
Value.BackupHostname	string	The hostname of this backup machine.
Value.NeedsUpdate	boolean	Whether the main server info needs to be refreshed.

Example - Read current value

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "<MachineName>-BackupHandler",
  "Name": "BackupActive",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "<MachineName>-BackupHandler",
  "Name": "BackupActive"
}

JSON

{
  "Value": {
    "Active": false,
    "BackupHostname": "MyMachine",
    "NeedsUpdate": false
  }
}

Activation Progress

Endpoints for monitoring whether a backup or server activation sequence is currently running.

BackupActivationInProgress [GET]

BackupActivationInProgress

Returns whether a backup activation sequence is currently in progress on this machine. The flag is set to `true` during the role-change handshake triggered by `ToggleBackupMode` and returns to `false` once the sequence completes. Clients can poll this value to wait for activation to finish before issuing further commands.

Wire format: [Topic, Message]

Send: GetTopic + {} → Receive: UpdateTopic (targeted) + {Value: ...}

No parameters — message is always {}.

Value

Value

boolean

Whether backup activation is currently in progress.

Example - Read current value

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "<MachineName>-BackupHandler",
  "Name": "BackupActivationInProgress",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "<MachineName>-BackupHandler",
  "Name": "BackupActivationInProgress"
}

JSON

{
  "Value": false
}

ServerActivationInProgress [GET]

ServerActivationInProgress

Returns whether a main-server activation sequence is currently in progress. The flag is `true` while the backup handler is promoting this machine to act as the main server, and returns to `false` once the promotion completes. Clients can poll this value to track server failover progress.

Wire format: [Topic, Message]

Send: GetTopic + {} → Receive: UpdateTopic (targeted) + {Value: ...}

No parameters — message is always {}.

Value

Value

boolean

Whether server activation is currently in progress.

Example - Read current value

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "<MachineName>-BackupHandler",
  "Name": "ServerActivationInProgress",
  "RespondTo": "<Service>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "<MachineName>-BackupHandler",
  "Name": "ServerActivationInProgress"
}

JSON

{
  "Value": false
}