prorm API Reference
    Preparing search index...

    Interface BackupConfig

    interface BackupConfig {
        primary: BackupSource;
        secondary?: BackupSource;
        staging?: {
            database: string;
            host: string;
            port?: number;
            username: string;
            password: string;
        };
        verification?: {
            verifyChecksum?: boolean;
            verifyEncryption?: boolean;
            verifyIntegrity?: boolean;
            minAgeHours?: number;
        };
        notifications?: {
            onSuccess?: boolean;
            onFailure?: boolean;
            emailRecipients?: string[];
            webhookUrl?: string;
        };
    }
    Index
    primary secondary? staging? verification? notifications?
    primary: BackupSource

    Primary backup source

    secondary?: BackupSource

    Secondary/backup backup source (for redundancy check)

    staging?: {
        database: string;
        host: string;
        port?: number;
        username: string;
        password: string;
    }

    Staging environment for test restores

    verification?: {
        verifyChecksum?: boolean;
        verifyEncryption?: boolean;
        verifyIntegrity?: boolean;
        minAgeHours?: number;
    }

    Verification settings

    Type Declaration

    • OptionalverifyChecksum?: boolean

      Verify checksum integrity (default: true)

    • OptionalverifyEncryption?: boolean

      Verify encryption (default: true)

    • OptionalverifyIntegrity?: boolean

      Verify backup is not corrupted (default: true)

    • OptionalminAgeHours?: number

      Minimum backup age to verify (default: 0)

    notifications?: {
        onSuccess?: boolean;
        onFailure?: boolean;
        emailRecipients?: string[];
        webhookUrl?: string;
    }

    Notification settings

    Settings
    Member Visibility

    On This Page
    Properties