Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
import type { BackupFileBrowseRequest, BackupFileEntry, BackupRestoreSelection } from '#lib/types/backup.js';
import type { Paginated, SearchPaginationSortRequest } from '#lib/types/shared.js';
import type {
CreateSystemBackup,
BackupHistoryEntry,
SystemBackupPolicyCollection,
SystemBackupRecoveryKey,
SystemBackupRun,
UpdateSystemBackupPolicy,
SystemVolumeBackupPolicyCollection,
UpdateSystemVolumeBackupPolicy,
SystemVolumeBackupOption,
SystemVolumeBackupRunResult,
RunSystemVolumeBackups
} from '#lib/types/system-backup.js';
import { transformPaginationParams } from '#lib/utils/tables.js';
import BaseAPIService from './api-service';
class SystemBackupService extends BaseAPIService {
async list(options?: SearchPaginationSortRequest): Promise<Paginated<SystemBackupRun>> {
const response = await this.api.get('/backups', { params: transformPaginationParams(options) });
return response.data;
}
async listHistory(options?: SearchPaginationSortRequest): Promise<Paginated<BackupHistoryEntry>> {
const response = await this.api.get('/backups/history', { params: transformPaginationParams(options) });
return response.data;
}
async getSystemVolumeConfig(): Promise<SystemVolumeBackupPolicyCollection> {
return this.handleResponse(this.api.get('/backups/volumes/config'));
}
async updateSystemVolumeConfig(policies: UpdateSystemVolumeBackupPolicy[]): Promise<SystemVolumeBackupPolicyCollection> {
return this.handleResponse(this.api.put('/backups/volumes/config', { policies }));
}
async listSystemVolumeOptions(): Promise<SystemVolumeBackupOption[]> {
return this.handleResponse(this.api.get('/backups/volumes/options'));
}
async runSystemVolumeBackups(request: RunSystemVolumeBackups = {}): Promise<SystemVolumeBackupRunResult> {
return this.handleResponse(this.api.post('/backups/volumes/run', request));
}
async getPolicies(): Promise<SystemBackupPolicyCollection> {
return this.handleResponse(this.api.get('/backups/policies'));
}
async updatePolicies(policies: UpdateSystemBackupPolicy[]): Promise<SystemBackupPolicyCollection> {
return this.handleResponse(this.api.put('/backups/policies', { policies }));
}
async generateRecoveryKey(): Promise<SystemBackupRecoveryKey> {
return this.handleResponse(this.api.post('/backups/recovery-key/generate'));
}
async setRecoveryKey(recoveryKey: string): Promise<{ configured: boolean }> {
return this.handleResponse(this.api.put('/backups/recovery-key', { recoveryKey }));
}
async create(input: CreateSystemBackup): Promise<SystemBackupRun> {
return this.handleResponse(this.api.post('/backups', input));
}
async restore(id: string, recoveryKey: string): Promise<void> {
await this.handleResponse(this.api.post(`/backups/${id}/restore`, { recoveryKey }));
}
async browseFiles(id: string, recoveryKey: string, request: BackupFileBrowseRequest): Promise<Paginated<BackupFileEntry>> {
const response = await this.api.post(`/backups/${id}/files/browse`, { recoveryKey }, { params: request });
return response.data;
}
async restoreFiles(id: string, recoveryKey: string, selection: BackupRestoreSelection): Promise<unknown> {
return this.handleResponse(this.api.post(`/backups/${id}/restore-files`, { recoveryKey, ...selection }));
}
async upload(id: string, s3DestinationId: string, recoveryKey: string): Promise<SystemBackupRun> {
return this.handleResponse(this.api.post(`/backups/${id}/upload`, { s3DestinationId, recoveryKey }));
}
async delete(id: string, recoveryKey: string): Promise<void> {
await this.handleResponse(this.api.delete(`/backups/${id}`, { data: { recoveryKey } }));
}
async discover(s3DestinationId: string, recoveryKey: string): Promise<number> {
return this.handleResponse(this.api.post('/backups/discover', { s3DestinationId, recoveryKey }));
}
}
export const systemBackupService = new SystemBackupService();