Update backup config
UpdateBackupConfig¶
UpdateBackupConfig
Description: Updates an existing backup endpoint configuration. The update is merge-style: name selects the record, and omitted fields keep their previous values.
Access Control¶
SESSION_ADMIN,SESSION_MANAGER
Request Parameters¶
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Yes | Existing backup endpoint name |
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": "UpdateBackupConfig",
"extID": "1",
"data": {
"name": "backup-eu-1",
"enable": 0,
"timeinterval": 7200,
"retry_attempts": 4,
"retry_delay": 10
}
}
Response Example¶
{
"name": "backup-eu-1",
"host": "10.10.10.20:5555",
"login": "backup",
"password": "secret",
"enable": 0,
"mode": 0,
"timeinterval": 7200,
"timeout": 120,
"retry_attempts": 4,
"retry_delay": 10
}
Errors¶
| Error | Description |
|---|---|
INVALID_DATA |
Request validation failed |
RET_NOT_FOUND |
Backup configuration with this name was not found |
RET_* |
Backend return code from backup configuration storage |