Description #

The parameterized cleanup allows fine grained control over which backups are deleted, based on the backup's metadata and the remote's state.

Configuration #

{
  "cleanup": [
    {
      "name": "myBasicCleanup",
      "keepCount": 5,
      "keepDays": 30
    }
  ],
  "remotes": [
    {
      "name": "remote-with-inline-cleanup",
      // ...
      "cleanup": {
        "keepCount": 5,
      }
    },
    {
      "name": "remote-with-inline-cleanup-2",
      // ...
      "cleanup": {
        "keepDays": 20,
      }
    },
    {
      "name": "remote-with-global-cleanup",
      // ...
      "cleanup": "myBasicCleanup"
    }
  ]
}

Available configuration options #

name #

  • required (when defined globally)

The name of the cleanup. This has to be a valid identifier.

keepCount #

  • required

The number of backups to keep. This option takes precedence over keepDays.

keepDays #

  • required

The minimum age of a backup to keep. Anything older will be deleted.