Last modified October 31, 2024

Backup Hook

List of arguments returned from pre/post backup hooks.

Pre Backup Hook Args

Pre Backup
Argument Index Value Possible Values
$1 Backup Job ID N/A
$2 Backup Job Name N/A
$3 Backup Job Type
  • 1 - Accounts
  • 2 - Directories
  • 3 - JB Config
$4 Backup Job Contains: Bitwise Value - Full Account: 511 = 1 + 2 + 4 + 8 + 16 + 32 + 64 + 128 + 256
  • 1 - Account Panel Config
  • 2 - Account Home Directory
  • 4 - Account Databases
  • 8 - Account Email
  • 16 - Cron Jobs
  • 32 - Accounts Domain
  • 64 - Account Certificates
  • 128 - Database Users
  • 256 - FTP Accounts
  • 511 - Full Account
$5 Backup Job Structure
  • 1 - Incremental
  • 2 - Archived
  • 4 - Compressed
$6 Backup Job Destinations: All Destination IDs are seperated by a comma ,. N/A
$7 Backup Start Date (EPOCH Time) N/A
$8 Backup Log ID N/A

Post Backup Hook Args

Post Backup
Argument Index Value Example
$1 Backup Job ID N/A
$2 Backup Job Name N/A
$3 Backup Job Type
  • 1 - Accounts
  • 2 - Directories
  • 3 - JB Config
$4 Backup Job Contains: Bitwise Value - Full Account: 511 = 1 + 2 + 4 + 8 + 16 + 32 + 64 + 128 + 256
  • 1 - Account Panel Config
  • 2 - Account Home Directory
  • 4 - Account Databases
  • 8 - Account Email
  • 16 - Cron Jobs
  • 32 - Accounts Domain
  • 64 - Account Certificates
  • 128 - Database Users
  • 256 - FTP Accounts
  • 511 - Full Account
$5 Backup Job Structure
  • 1 - Incremental
  • 2 - Archived
  • 4 - Compressed
$6 Backup Job Destinations: All Destination IDs are seperated by a comma ,. N/A
$7 Backup Start Date (EPOCH Time UTC) N/A
$8 Backup End Date (EPOCH Time UTC) N/A
$9 Backup Status (Queue Object Status)
  • 1 - Pending
  • 2 - Processing
  • 100 - Completed
  • 101 - Partially Completed
  • 102 - Failed
  • 103 - Aborted
  • 104 - Never Finished
$10 Backup Log ID N/A