Cluster Backups

Update a Backup Job

Changed on

Update a scheduled backup job

put/cluster/backups/jobs/{id}

Request

  • Base URL
    https://sylve.lan:8181/api
  • URL
    https://sylve.lan:8181/api/cluster/backups/jobs/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Backup Job ID

Request body

cronExprstring
enabledboolean
encryptedboolean
jailRootDatasetstring
modestring required
namestring required
pruneKeepLastinteger
pruneTargetboolean
recursiveboolean
runnerNodeIdstring
sourceDatasetstring
stopBeforeBackupboolean
targetIdinteger required

Response

Success

dataunknown
errorstring
messagestring
statusstring

Changes