Perform a backup instantly

POST /maintenance/backup
To Perform a backup instantly.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • backup_filename

    string

    required

    Filename for the backup.
  • include_phone_system_core

    boolean

    required

    To include PBX core data in the backup.
  • include_system_prompts

    boolean

    required

    To include system prompts in the backup.
  • include_voicemails

    boolean

    required

    To include voicemails in the backup.
  • include_recordings

    boolean

    required

    To include recordings in the backup.
  • include_call_history_records

    boolean

    required

    To include call details records in the backup.
  • include_phone_provision_and_firmware_files

    boolean

    required

    To include phone provision and firmware files in the backup.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "backup_filename": "backup.zip",
    "include_phone_system_core": true,
    "include_system_prompts": true,
    "include_voicemails": true,
    "include_recordings": true,
    "include_call_history_records": true,
    "include_phone_provision_and_firmware_files": true
}

Response

Placeholders

Sample Response

List a page of backups

GET /maintenance/backup_file/list
List a page of backups.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • pagination

    integer

    required

    The pagination of paging.
  • pagesize

    integer

    optional

    The pagesize of paging.
  • sort_by

    enum

    optional

    Values include "DEFAULT" and "Optional" Default value will be used when user does not specify value for this field.

Sample Request

https://example.com/api/maintenance/backup_file/list?access_token=196ACE20C6F34027895F7F95402BB164&pagesize=100&pagination=1&sort_by=DEFAULT

Response

Placeholders
  • pagination

    integer

    required

    The pagination of paging.
  • pagesize

    integer

    optional

    The pagesize of paging.
  • sort_by

    enum

    optional

    Values include "DEFAULT" and "Optional" Default value will be used when user does not specify value for this field.
  • page_count

    integer

    required

    The total count of pages.
  • count

    integer

    required

    Current pagesize.
  • backup_files

    array

    required

    Backup file array.
    Show child attributes

Sample Response

{
    "pagination": 1,
    "pagesize": 100,
    "sort_by": "DEFAULT",
    "page_count": 100,
    "count": 100,
    "backups": [
        {
            "filename": "backup.zip",
            "file_size": 10,
            "file_version": "8.0.0.0"
        }
    ]
}

Delete a backup file

POST /maintenance/backup_file/delete
Delete a certain backup file.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • backup_filename

    string

    required

    Filename of backup file to be deleted.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "backup_filename": "backup1.zip"
}

Response

Placeholders

Sample Response

Perform restore instantly

POST /maintenance/restore
Perform restore instantly.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • backup_filename

    string

    required

    Filename of the backup.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "backup_filename": "backup1.zip"
}

Response

Placeholders

Sample Response

Retrieve backup schedule information

GET /maintenance/backup_schedule/show
Retrieve information for certain backup schedule.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.

Sample Request

https://example.com/api/maintenance/backup_schedule/show?access_token=196ACE20C6F34027895F7F95402BB164

Response

Placeholders
  • enabled

    boolean

    required

    Indicates if backup schedule is enabled.
  • include_phone_system_core

    boolean

    required

    To include PBX core data in the backup.
  • include_system_prompts

    boolean

    required

    To include system prompts in the backup.
  • include_voicemails

    boolean

    required

    To include voicemails in the backup.
  • include_recordings

    boolean

    required

    To include recordings in the backup.
  • include_call_history_records

    boolean

    required

    To include call history records in the backup.
  • include_phone_provision_and_firmware_files

    boolean

    required

    To include phone provision and firmware files in the backup.
  • time

    string

    required

    Time.
  • day

    string

    required

    Day.
  • type

    string

    required

    'WEEKLY' or 'DAILY'.

Sample Response

{
    "enabled": true,
    "include_phone_system_core": true,
    "include_system_prompts": true,
    "include_voicemails": true,
    "include_recordings": true,
    "include_call_history_records": true,
    "include_phone_provision_and_firmware_files": true,
    "type": "WEEKLY",
    "time": 25200,
    "day": "MONDAY"
}

Update backup schedule information

POST /maintenance/backup_schedule/update
Update information for certain backup schedule.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • enabled

    boolean

    required

    Indicates if backup schedule is enabled.
  • include_phone_system_core

    boolean

    required

    To include PBX core data in the backup.
  • include_system_prompts

    boolean

    required

    To include system prompts in the backup.
  • include_voicemails

    boolean

    required

    To include voicemails in the backup.
  • include_recordings

    boolean

    required

    To include recordings in the backup.
  • include_call_history_records

    boolean

    required

    To include call history records in the backup.
  • include_phone_provision_and_firmware_files

    boolean

    required

    To include phone provision and firmware files in the backup.
  • time

    string

    required

    Time.
  • day

    string

    required

    Day.
  • type

    string

    required

    'WEEKLY' or 'DAILY'.

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "enabled": true,
    "include_phone_system_core": true,
    "include_system_prompts": true,
    "include_voicemails": true,
    "include_recordings": true,
    "include_call_history_records": true,
    "include_phone_provision_and_firmware_files": true,
    "type": "WEEKLY",
    "time": 25200,
    "day": "MONDAY"
}

Response

Placeholders

Sample Response