API : PBX : Backup

A PBX backup is a ZIP file containing the customers PBX configuration. The content is selectable from these categories:

Category Description
dialplan All dialplan items. Automatically includes the customer-owned music on hold classes and the PBX variables and switches.
audio The customers sound files, including the binary audio data. Personal voicemail greetings are never included and are never touched by a restore.
sipPhones SIP phones. SIP credentials are never included and are regenerated on restore.
users Complete users: identity, access level, state, PBX user product, voicemail settings including the greeting audio files, the users picture, softkeys, communicator auto states, auto presence, recording preferences, MS365 settings, view-other-party override - and the login credentials (password hash, 2FA key, pin code, tokens) so users can log in again after a full restore.

A backup can be downloaded as a file and/or stored on the Telecom X file server. A backup can be restored onto the customer it was taken from (disaster recovery) or onto another customer (deploying a template).

When a backup is restored, all items get new ids - every reference between the restored items (gotos, audio, music on hold, users, phones) is rewritten accordingly. Two restore modes exist:

Mode Description
replace The existing configuration in the selected categories is deleted from the target customer before the backup is restored. Users are never deleted - they are matched by email address. Use for disaster recovery.
deploy The backup is added on top of the target customers existing configuration. Conflicts (internal numbers, MAC addresses) are reported as warnings. Use for deploying a template onto another customer.

A backup that includes the users category contains login credentials - treat backup files as confidential.

Limits for backups stored on the server: max 25 stored backups and max 5 GB total storage per customer.

All stored backups are deleted when the PBX feature is removed from the customer or the customer is deleted.

Section Description
List List the stored backups and the storage usage
Download Build a backup and download it as a ZIP file
Store Build a backup and store it on the file server
Download stored Download a stored backup
Restore Restore from an uploaded backup file
Restore stored Restore from a stored backup
Delete Delete a stored backup