Skip to content

Add backup config

AddBackupConfig

AddBackupConfig

Description: Creates a backup endpoint configuration record.

Access Control

SESSION_ADMIN, SESSION_MANAGER

Request Parameters

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

Request Example

{
  "command": "AddBackupConfig",
  "extID": "1",
  "data": {
    "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
  }
}

Response Example

{
  "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
}

Errors

Error Description
INVALID_DATA Request validation failed, for example name is missing
RET_* Backend return code from backup configuration storage