snapshot prune
The mirrorctl snapshot prune command removes old snapshots according to the configured retention
policy or based on command-line flags that override that policy.
mirrorctl snapshot prune [mirror-ids...] [flags]Usage
Prune snapshots for all mirrors using configured retention policies:
mirrorctl snapshot prunePrune snapshots for a specific mirror:
mirrorctl snapshot prune debianKeep only the last 10 snapshots:
mirrorctl snapshot prune debian --keep-last 10Keep snapshots created within the last 60 days:
mirrorctl snapshot prune debian --keep-within 60dCombine retention policies:
mirrorctl snapshot prune debian --keep-last 5 --keep-within 30dPreview what would be deleted without actually deleting:
mirrorctl snapshot prune debian --dry-runArguments
| Argument | Required | Description |
|---|---|---|
mirror-ids |
No | Optional list of mirror IDs to prune snapshots for. Mirror IDs must match the keys defined in the [mirrors] section of your configuration file. If not specified, snapshots for all mirrors will be pruned. |
Flags
| Flag | Default | Usage |
|---|---|---|
--config, -c |
/etc/mirrorctl/mirror.toml |
Path to the configuration file. |
--keep-last |
0 |
Number of most recent snapshots to keep. Overrides configuration file setting. |
--keep-within |
Keep snapshots within the specified duration (e.g., “30d”, “1w”). Overrides configuration file setting. | |
--dry-run |
false |
Show what would be deleted without actually deleting snapshots. |
--verbose-errors |
false |
Show detailed error information including stack traces. |
Duration Format
The --keep-within flag accepts duration strings with the following suffixes:
d- days (e.g., “30d” = 30 days)w- weeks (e.g., “4w” = 4 weeks)h- hours (e.g., “168h” = 7 days)
Retention Policy
Snapshots are protected from pruning if they meet any of the following criteria:
- Within the most recent N snapshots (when
--keep-lastis specified) - Created within the specified time period (when
--keep-withinis specified) - Currently published to production
- Currently published to staging
When both --keep-last and --keep-within are specified, a snapshot is kept if it matches either criterion.
Exit Status
The command exits with status 0 on success and 1 on error.
See Also
- Configuration Reference - Details on snapshot retention configuration
- snapshot create - Create a snapshot
- snapshot list - List snapshots
- snapshot delete - Manually delete snapshots