Skip to content

Get backup config

GetBackupConfig

GetBackupConfig

Description: Returns configured backup endpoint records stored by the backup module.

Access Control

SESSION_ADMIN, SESSION_MANAGER

Request Parameters

No parameters required.

Response Data

Returns rows as an array of backup configuration records.

Field Type Description
name string Backup endpoint name, primary key
host string Backup server host
login string Login or login list used by the backup endpoint
password string Password stored for the backup endpoint
enable int 1 enabled, 0 disabled
mode int Backup mode, for example full or fast backup
timeinterval int Interval between backup operations in seconds
timeout int Socket send/receive timeout for one upload attempt, in seconds
retry_attempts int Total upload attempts, including the first attempt
retry_delay int Delay between retry attempts, in seconds

Request Example

{
  "command": "GetBackupConfig",
  "extID": "1",
  "data": {}
}

Response Example

{
  "rows": [
    {
      "name": "backup-eu-1",
      "host": "10.10.10.20:5555",
      "login": "backup",
      "password": "secret",
      "enable": 1,
      "mode": 0,
      "timeinterval": 3600,
      "timeout": 120,
      "retry_attempts": 3,
      "retry_delay": 5
    }
  ]
}