Backup Handler API - Calls | Pixotope Help Center

Service name: BackupHandler (singleton, one per network). This service is only available when a backup client has been added to the network.

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.

No params.

Result

Result

BOOLEAN

Always `true` when the Backup Handler responds.

Example - Health check

Request (you send)

JSON

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

JSON

{}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "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.

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": "BackupHandler",
  "RespondTo": "<Service>",
  "Method": "ToggleBackupMode",
  "ID": "<ID>"
}

JSON

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

Response (you receive)

JSON

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

JSON

{
  "Result": true
}