Last modified October 31, 2024

Restore Hook

List of arguments returned from pre/post restore hooks.

Pre Restore Hook Args

Argument Index Value Possible Values
$1 Backup Type
  • 1 - Accounts
  • 2 - Directories
  • 3 - JB Config
$2 Backup 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
$3 Account ID N/A
$4 Account User Name N/A
$5 Backup Items: All items are separated by a comma N/A
$6 Restore Start Date (Epoch Time UTC) N/A
$7 Restore Log ID N/A

Post Restore Hook Args

Argument Index Value Example
$1 Backup Type
  • 1 - Accounts
  • 2 - Directories
  • 3 - JB Config
$2 Backup 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
$3 Account ID The Account ID only exists for Account Restore Type.
$4 Account Name Account User Name only exists for Account Restore Type.
$5 Backup Items: All items are separated by a comma ,. N/A
$6 Restore Start Date (Epoch Time UTC) N/A
$7 Restore End Date (Epoch Time UTC) N/A
$8 Restore Status (Queue Object Status)
  • 1 - Pending
  • 2 - Processing
  • 100 - Completed
  • 101 - Partially Completed
  • 102 - Failed
  • 103 - Aborted
  • 104 - Never Finished
$9 Restore Log ID N/A