Skip to content
SHC Docs

Retention module

Source: modules/retention/.

At a glance

Section titled “At a glance”
CLIshc retention
Subcommands2
HTTP endpointssee the route reference
Events emitted—
Error codessee the error code reference
Service classes—
Cross-module depsbackup

Source layout

Section titled “Source layout”
modules/retention/
├── command.go
├── types.go
└── commands/

CLI entry points

Section titled “CLI entry points”
  • shc retention — manage backup retention policies

Responsibilities

Section titled “Responsibilities”

The retention module implements retention policies — rules that govern how long backups, completed jobs, and audit entries are kept before pruning. It is a thin CLI surface (shc retention) over the retention configuration stored in the database; the actual pruning runs in the maintenance cron tier (see default.yaml maintenance.retention_cleanup).