Backup Handler API - Calls | Pixotope Help Center

General

General Backup Handler service diagnostics.

BackupHandlerHealth [CALL]

BackupHandlerHealth

Checks whether the Backup Handler service is alive and responsive. Used by other services to verify that the Backup Handler is reachable before issuing further commands.

Wire format: [Topic, Message]

Send: CallTopic + {Params: ...} → Receive: CallResultTopic + {Result: ...}

No params.

Result

Result

boolean

Always `true` when the Backup Handler responds.

Example - Health check

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "<MachineName>-BackupHandler",
  "RespondTo": "<Service>",
  "Method": "BackupHandlerHealth",
  "ID": "<ID>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "<MachineName>-BackupHandler",
  "Method": "BackupHandlerHealth",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

Backup Mode

Endpoints for activating and deactivating backup mode on this machine.

ToggleBackupMode [CALL]

ToggleBackupMode

Activates or deactivates backup mode on this machine. Has no effect unless this machine is designated as a backup server. When the state changes, triggers the backup activation sequence and broadcasts the updated `BackupActive` state to all subscribers.

Wire format: [Topic, Message]

Send: CallTopic + {Params: ...} → Receive: CallResultTopic + {Result: ...}

Params

Active

boolean

Whether to activate backup mode.

Result

Result

boolean

Whether this machine is configured as a backup server (regardless of whether the activation was applied).

Example - Activate backup mode

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "<MachineName>-BackupHandler",
  "RespondTo": "<Service>",
  "Method": "ToggleBackupMode",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Active": true
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "<MachineName>-BackupHandler",
  "Method": "ToggleBackupMode",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}