Download an existing backup file from the object store to your local
enforce_provisioning_action
- bak.toml (S3 as an example)
# Enable Object Storage
[object_storage]
enabled = true
# Using S3 protocol (Backblaze B2 compatible)
provider = "s3"
# Bucket Name
bucket = "TestBucket"
# Object key prefix (like folder path)
prefix = "test_local"
# S3 Compatible Endpoints (Backblaze B2 + East)
endpoint = "https://s3.xxxxxxxxxxxxxx.com"
Region
region = "ca-east-006"
Access Key ID
access_key_id = "xxxxxxxxxxxxxx"
Access key
access_key_secret = "xxxxxxxxxxxxxx"
# Use path style URL (bucket/object instead of web hosting style)
path_style = true
Perform the preliminary checks: §
Open Terminal Execution
# Database Backup Precheck
peppykeep backup download-artifact --remote-key test_local_voos/test_717_file/test_717_file-bak_20260703_172943.ppk --output-file C:\\Users\\admin\\AppData\\Local\\Temp\\test\\testdb.ppk --config-home %USERPROFILE%\.peppykeep\conf
When the pre-test is successful, the output is as follows:
=== Dry Run ===
Action : backup download-artifact
RemoteKey : test_local_voos/test_717_file/test_717_file-bak_20260703_172943.ppk
Output : C:\\Users\\admin\\AppData\\Local\\Temp\\test\\testdb.ppk
Bucket : VoosTestBucket
Provider : s3
RestoreArchive : false
Wait : false
RestoreDays : 1
WaitTimeout : 1800
PollInterval : 30
Next : Re-run with --apply to execute.
Result
| Field | Description |
|---|---|
Action | Type of operation performed: backup download-artifact (download backup file) |
RemoteKey | Remote file path in object store: test_local_voos/test_717_file/test_717_file-bak_20260703_172943.ppk |
Output | Local output file path: C:\\ Users\\ admin\\ AppData\\ Local\\ Temp\\ test\\ testdb.ppk |
Bucket | Bucket name: VoosTestBucket (read from configuration file) |
Provider | Object storage provider: s3 (read from configuration file) |
RestoreArchive | Do you want to restore from archive storage: false (no) |
Wait | Waiting for archive recovery to complete: false (No) |
RestoreDays | Number of days to keep after archive restore: 1 (days) |
WaitTimeout | Timeout waiting for archive restore: 1800 (seconds) |
PollInterval | Polling archive recovery state interval: 30 (seconds) |
Next | Next Action Tip: Re-run with --apply to execute. (need to add --apply parameter to execute) |
Perform a backup
Performing a Database Backup
peppykeep backup download-artifact --remote-key test_local_voos/test_717_file/test_717_file-bak_20260703_172943.ppk --output-file C:\\Users\\admin\\AppData\\Local\\Temp\\test\\testdb.ppk --apply --config-home %USERPROFILE%\.peppykeep\conf
After executing the backup command, the output on success is as follows:
=== Completed ===
Action : backup download-artifact
RemoteKey : test_local_voos/test_717_file/test_717_file-bak_20260703_172943.ppk
Output : C:\\Users\\admin\\AppData\\Local\\Temp\\test\\testdb.ppk
Bucket : VoosTestBucket
Provider : s3
RestoreArchive : false
Resumed : false
Written : 0
TotalSize : 1186
Status : Command completed successfully.
Result
| Field | Description |
|---|---|
Action | Type of operation performed: backup download-artifact (download backup file) |
RemoteKey | Remote file path in object store: test_local_voos/test_717_file/test_717_file-bak_20260703_172943.ppk |
Output | Local output file path: C:\\ Users\\ admin\\ AppData\\ Local\\ Temp\\ test\\ testdb.ppk |
Bucket | Bucket name: VoosTestBucket (read from configuration file) |
Provider | Object storage provider: s3 (read from configuration file) |
RestoreArchive | Do you want to restore from archive storage: false (no) |
Resumed | Whether to enable breakpoint continuation: false (no) |
Written | Number of bytes actually written this time: 0 (bytes) |
TotalSize | Total size of remote object: 1186 (bytes) |
Status | Execution Status: Command completed successfully. (Command executed successfully) |