BackupDestination

idstringrequired

namestringrequired

typeBackupDestinationTyperequired

local is a directory — the boot device, the pool, or an external disk's mount. Every other type is written through rclone: smb, s3 (any S3-compatible store), sftp, webdav, or rclone for a remote already set up in rclone's own config. An NFS share is a local destination at the path the host has mounted it.

Possible values: [local, smb, s3, sftp, webdav, rclone]

pathstringrequired

The directory for a local destination; for a remote one, the path within it (bucket and prefix, share and folder).

options object

The non-secret rclone settings of a remote destination.

property name*string

enabledbooleanrequired

encryptbooleanrequired

Always true for a remote destination.

retention objectrequired

dailyinteger<int32>required

Possible values: >= 0 and <= 1000

weeklyinteger<int32>required

Possible values: >= 0 and <= 1000

monthlyinteger<int32>required

Possible values: >= 0 and <= 1000

hasSecretsbooleanrequired

Whether credentials are stored for this destination.

lastSuccessfulBackupAtstring<date-time>

Absent until a backup has been written here.

stalebooleanrequired

An enabled destination that has gone two days without a successful backup, counted from its creation until its first.

createdAtstring<date-time>required

BackupDestination

{
  "id": "string",
  "name": "string",
  "type": "local",
  "path": "string",
  "options": {},
  "enabled": true,
  "encrypt": true,
  "retention": {
    "daily": 0,
    "weekly": 0,
    "monthly": 0
  },
  "hasSecrets": true,
  "lastSuccessfulBackupAt": "2024-07-29T15:51:28.071Z",
  "stale": true,
  "createdAt": "2024-07-29T15:51:28.071Z"
}