Builds a PBX backup of the selected categories and stores it on the Telecom X file server.
Limits per customer: max 25 stored backups and max 5 GB total storage. The limits are checked before the backup is built and again with the actual size before it is stored.
Building the backup downloads all audio binaries from the audio file server, so the request may take a while for customers with many audio files.
| URL | https://api.telecomx.dk/pbx/backup/store | |
|---|---|---|
| Method | POST | |
| Access level | OWNER if the customer is the users own customer. RESELLER if the customer belongs to the reseller. RESELLER_ADMIN and ADMIN for all customers. |
|
| Body | customer | [optional] Id of customer to back up. Defaults to the users own customer. |
| name | Display name for the stored backup, 1-100 characters. | |
| include | Array of categories to include: dialplan, audio, sipPhones, users. At least one is required. | |
{ customer: '12345678901234567890ABCD', name: 'Before dialplan rebuild', include: [ 'dialplan', 'audio' ] }
The created backup document:
| JSON object | ||
|---|---|---|
| Property | Type | Description |
| _id | Id | Unique id of the stored backup. |
| customer | Id | Id of the customer the backup was created from. |
| name | String | Display name of the backup. |
| categories | Array | The categories included in the backup. |
| counts | Object | Number of primary items per included category. |
| size | Number | Size of the backup ZIP file in bytes. |
| formatVersion | Number | Version of the backup file format. |
| fileId | Id | Id of the ZIP file on the file server. |
| createdBy | Id | Id of the employee who created the backup. |
| createdAt | Date | When the backup was created. |
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 404 | customer | Customer not found |
| 409 | count | The maximum number of stored backups has been reached - delete old backups first |
| 409 | size | The backup storage limit has been reached - delete old backups first |
| 422 | name / include | Invalid name or categories |
| 500 | file | The backup could not be uploaded to the file server |