| Name |
string |
name |
Human-readable name of the backup job. |
| Description |
string |
description |
Optional free-text description of the job's purpose. |
| Enabled |
bool |
enabled |
Whether the scheduler runs this job automatically. |
| Schedule |
string |
schedule |
Cron expression controlling when the job runs. Empty means manual-only. |
| BackupTypeChain |
string |
backup_type_chain |
Backup mode for the job: full, incremental, or differential. Incremental and differential jobs automatically run as a full backup on their first run, when the job has no previous restore point to attach to. |
| RetentionCount |
int |
retention_count |
Number of most-recent restore points to keep. Ignored when LTR buckets are set. |
| RetentionDays |
int |
retention_days |
Age in days after which restore points are pruned. Ignored when LTR buckets are set. |
| Compression |
string |
compression |
Compression algorithm applied to the archive (e.g. zstd, gzip, none). |
| CompressionLevel |
string |
compression_level |
Compression level trading time for size (fastest, default, better, best). Empty means the algorithm's default. |
| Encryption |
string |
encryption |
Encryption mode for the archive (e.g. none, passphrase). |
| ContainerMode |
string |
container_mode |
How Docker containers are handled during backup (e.g. stop, pause, hot). |
| VMMode |
string |
vm_mode |
How libvirt VMs are handled during backup (e.g. shutdown, snapshot). |
| PreScript |
string |
pre_script |
Shell script run before the backup starts. |
| PostScript |
string |
post_script |
Shell script run after the backup completes. |
| NotifyOn |
string |
notify_on |
When to send notifications for this job ("always", "failure", or "never"). |
| VerifyBackup |
bool |
verify_backup |
Whether to verify the backup immediately after it is written. |
| DeferRemoteUpload |
bool |
defer_remote_upload |
When true, stage the archive locally and upload to remote storage asynchronously. |
| KeepLatest |
int |
keep_latest |
Long-term retention: number of most-recent restore points to always keep. |
| KeepDaily |
int |
keep_daily |
Long-term retention: number of daily restore points to keep. |
| KeepWeekly |
int |
keep_weekly |
Long-term retention: number of weekly restore points to keep. |
| KeepMonthly |
int |
keep_monthly |
Long-term retention: number of monthly restore points to keep. |
| KeepYearly |
int |
keep_yearly |
Long-term retention: number of yearly restore points to keep. |
| VerifySchedule |
string |
verify_schedule |
Cron expression for scheduled re-verification. Empty means none. |
| VerifyMode |
string |
verify_mode |
Verification depth for scheduled verification ("quick" or "deep"). |
| FullBackupSchedule |
string |
full_backup_schedule |
Cron expression that forces a FULL backup on its own cadence, so an incremental or differential job carries its periodic full. Empty means none; ignored for a full chain. |
| RetryMaxOverride |
*int64 |
retry_max_override |
Per-job override for the maximum retry count. Null uses the global default. |
| RetryDelaysOverride |
*string |
retry_delays_override |
Per-job override for the retry backoff schedule (JSON array of seconds). Null uses the global default. |
| AnomalySensitivity |
string |
anomaly_sensitivity |
Per-job anomaly-detection sensitivity override. Empty uses the global default. |
| MaxParallelUploads |
int |
max_parallel_uploads |
Maximum concurrent upload workers for this job. 0 uses the default of 3. |
| AdaptiveEnabled |
bool |
adaptive_enabled |
Adaptive backups: postpone this job's runs while its containers, VMs, or folders are actively in use, re-checking until they go idle (or the max-postpone window elapses). Idle thresholds come from the global adaptive settings. |
| AutoIncludeContainers |
bool |
auto_include_containers |
When enabled, newly discovered Docker containers are automatically added to this job on each backup run. |