kopiaplan

Loading tasks...

Task Name

Backup Path
-
Command
-
API URL
-
Description
-
Path cannot be changed after task creation
URL-safe identifier for API endpoint: /api/run-kopia/your-slug
Will be added as --description flag to help identify this backup
Tags for filtering snapshots later (--tags)
Number of files to upload simultaneously (--parallel). More = faster but uses more resources
Force recalculation of file hashes to detect changes (--force-hash)

Hook Scripts

Execute custom bash scripts before and after snapshot creation. Use hooks to prepare data, stop services, or perform post-backup actions.

Script executed before creating snapshot. Use to prepare data or stop services.
Enabled: Snapshot creation proceeds even if pre-hook fails.
Disabled: Snapshot is skipped if pre-hook returns non-zero exit code.
Script executed after successful snapshot creation. Only runs if backup succeeded.
Status: Loading...

Retention Policy

Configure how long to keep snapshots for this task. Leave empty to use global defaults.

Most recent backups to keep
Hourly backups to keep
Daily backups to keep
Weekly backups to keep
Monthly backups to keep
Annual backups to keep

Latest Execution Log

No logs available

Snapshot Verification

Snapshot verification checks the integrity of your backup data by validating checksums and metadata. This ensures your backups can be restored successfully.
API Endpoint
Loading...
GET request to this URL will verify the latest snapshot for this task
Loading statistics...

Loading snapshots...

Loading snapshots...

Select backup source

Snapshots

Backup Health Dashboard

Monitor backup health, detect issues, and get predictive insights

Loading health data...

Settings

General

General Settings. Paths and mount point

Base directory for folder browser
Directory where snapshots will be mounted
Default directory for restoring files

Global Retention Policy

Configure how long to keep snapshots. These settings apply to all tasks unless overridden per-task.

Most recent backups to keep
Hourly backups to keep
Daily backups to keep
Weekly backups to keep
Monthly backups to keep
Annual backups to keep

Ignore Rules

Configure patterns to exclude files and folders from snapshots. One pattern per line.

Loading rules...
Patterns: Use * for any chars, ** for dirs, ? for one char, /pattern for root only, ! to negate
Examples of Kopiaignore Rules
Rule Explanation Matches Ignores
logs Matches files and folders that are named logs thesis/logs/
thesis/chapters/logs/		 2 directories
6 files
/logs Matches files and folders named logs only within parent directory thesis/logs/ 1 directory
5 files
*.db Matches files with extension .db thesis/tmp.db
thesis/logs/log.db		 0 directories
5 files
*.db* Matches files with extension .db followed by any character thesis/tmp.db
thesis/logs/tmp.dba		 0 directories
6 files
**/logs/** Matches all occurrences of logs within the thesis and sub-directories thesis/logs/
thesis/chapters/logs/		 2 directories
6 files
chapters/**/*.log Matches all files with extension .log in all sub-directories within chapters thesis/chapters/logs/chapter.log 0 directories
1 file
*.* Matches all files in thesis thesis/
thesis/tmp.db
(all files)		 5 directories
17 files (all)
!*.* Matches no files in thesis - 0 directories
0 files
[a-z]?tmp.db Matches files beginning with characters between a-z, followed by a single character, ending with tmp.db thesis/abtmp.db 0 directories
1 file
?tmp.db Matches files with exactly one character ending with tmp.db thesis/atmp.db 0 directories
1 file
[a-z]*tmp.db Matches files beginning with characters between a-z, followed by zero or multiple characters, ending with tmp.db thesis/abtmp.db
thesis/atmp.db
thesis/logs/tmp.db		 0 directories
3 files
Special Operators: # comment, ! negate, * any chars, ** any directories, ? one char, [0-9] range, / root only

Pushover Notifications

Configure Pushover notifications for backup events. Get notified when snapshots succeed or fail.

Get this from pushover.net/apps
Find this in your Pushover dashboard
Only send notifications for events at or above this level
Choose the format for notification messages. Text is recommended for Pushover.
Advanced: Override the default message template using Go template syntax. Leave empty to use Kopia's built-in template.
Available Template Variables:
{{.Subject}} - Default notification subject
{{.Body}} - Default notification body
{{.Hostname}} - Server hostname
{{.EventArgs.OverallStatus}} - Status (SUCCESS/ERROR)
{{.EventTime | formatTime}} - Event timestamp
{{.KopiaBuildVersion}} - Kopia version
Default template:
{{.Subject}}: {{.Body}}

Snapshot Verification

Configure how snapshot verification should work. Verification checks the integrity of your backup data.

Quick (0%): Only verifies metadata and file structure. Fast, but doesn't check actual file content.
 Standard (10%): Verifies 10% of files by downloading and checking their content. Good balance.
 Deep (50%): Verifies half of all files. More thorough but takes longer.
 Full (100%): Downloads and verifies every file. Very slow but most thorough.

Repository Maintenance

Clean up deleted snapshots and free disk space. This runs garbage collection to permanently remove unreferenced data blocks.

Content Blocks
-
Repository Size
-
API Endpoints:
GET /api/maintenance/stats - Get repository statistics
GET /api/maintenance/run?full=true - Run GC in background
POST /api/maintenance/run?full=true - Run GC and wait for result

Task Backups

Create and restore backups of your task configurations. Backups include all task settings, paths, and options.

Loading backups...

API Endpoints:
GET /api/backups/create - Create backup and return path