Table of Contents

API : PBX : Backup list

Introduction

Returns the PBX backups stored on the file server for a customer, together with the current storage usage and the limits.

Request

URL https://api.telecomx.dk/pbx/backup
Method GET
Access level OWNER if the backups belong to the users own customer.
RESELLER if the customer belongs to the reseller.
RESELLER_ADMIN and ADMIN for all customers.
Query customer [optional] Id of customer to list backups for. Defaults to the users own customer.

Query examples

https://api.telecomx.dk/pbx/backup
https://api.telecomx.dk/pbx/backup?customer=12345678901234567890ABCD

Response

JSON object
Property Type Description
backups Array List of stored backups, newest first, see definition below.
limits Object Current usage and limits, see definition below.
Backup object
Property Type Description
_id Id Unique id of the stored backup.
name String Display name of the backup.
categories Array The categories included in the backup: dialplan, audio, sipPhones, users.
counts Object Number of primary items per included category, e.g. { dialplan: 42, audio: 17 }.
size Number Size of the backup ZIP file in bytes.
formatVersion Number Version of the backup file format.
createdBy Object The employee who created the backup: { _id, name }.
createdAt Date When the backup was created.
Limits object
Property Type Description
count Number Number of stored backups.
maxCount Number Maximum number of stored backups per customer.
size Number Total size of the stored backups in bytes.
maxSize Number Maximum total size of stored backups per customer, in bytes.

Example

{
  backups: [
    {
      _id: '12345678901234567890ABCD',
      name: 'Before dialplan rebuild',
      categories: [ 'dialplan', 'audio' ],
      counts: { dialplan: 42, audio: 17 },
      size: 52428800,
      formatVersion: 1,
      createdBy: { _id: '12345678901234567890AAAA', name: 'Anders And' },
      createdAt: '2026-08-19T12:00:00.000Z'
    }
  ],
  limits: {
    count: 1,
    maxCount: 25,
    size: 52428800,
    maxSize: 5368709120
  }
}

Errors

Error code Message Description
403 access_denied Insufficient access level
404 customer Customer not found
500 internal_error <Unspecified>