Page tree
Skip to end of metadata
Go to start of metadata

Under Development

While this interface should be generally stable there may be additional changes pre-beta


By default we look for hooks in the /home/asterisk/Backup folder. If you want to put scripts in a different location you may set an environment variable.

BACKUPHOOKDIR=/path/to/your/directory fwconsole bu --backup [ID]


export BACKUPHOOKDIR=/path/to/your/directory

The script can be in any language as long as it is executable and has the appropriate header below.

By Header

In your chosen language add one of the following as a comment. The files in the hook directory will be scanned

  • pre:restore
  • post:restore
  • pre:backup
  • post:backup

By Environment Variables

  • BACKUPPREHOOKS - Run before backup.
  • BACKUPPOSTHOOKS - Run after backup.
  • RESTOREPREHOOKS - Run before restore.
  • RESTOREPOSTHOOKS - Run after restore.

Each of these items will accept a single item or a comma separated list. The items must be the full path.





  1. backupid
  2. transactionid


  1. backupid
  2. transactionid
  3. base64 encoded json string with signatures
  4. base64 encoded json string with errors


  1. transactionid
  2. base64 encoded json string with backup data


  1. transactionid
  2. base64 encoded json string with backup data
  • No labels