List backup files

GET /backup_file/list
List backup files
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • pagination

    integer

    required

    The pagination of paging.

    format : int32

  • pagesize

    integer

    required

    The size of paging.
  • sort_by

    string

    optional

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

    enum : ['DEFAULT', 'OPTIONAL']

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/maintenance/backup_file/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                      
                    

Responses

200
Successful operation
application/json
  • page_count

    integer

  • pagination

    integer

  • sort_by

    string

  • pagesize

    integer

  • backup_files

    array

    Show child attributes
  • count

    integer

Sample Response

                      
{
    "sort_by": "DEFAULT",
    "page_count": 80,
    "pagesize": 10,
    "pagination": 8,
    "count": 100
}
                      
                    

add a backup file

POST /backup_file/add
add a backup file
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • fileid

    string

    required

    file download id for the backup.
  • filename

    string

    required

    Filename for the backup.

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/maintenance/backup_file/add \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "filename": "a.zip",
    "fileid": "2.1asdadas"
}'
                      
                    

Responses

200
Successful operation

Sample Response

                      
                      
                    

Perform restore instantly

POST /restore
Perform restore instantly
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • fileid

    string

    required

    file download id for the backup.
  • filename

    string

    required

    Filename for the backup.

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/maintenance/restore \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "filename": "a.zip",
    "fileid": "2.1asdadas"
}'
                      
                    

Responses

200
Successful operation
400
Invalid backup file name.

Sample Response

                      
                      
                    

Perform a backup instantly

POST /backup
Perform a backup instantly
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • include_phone_provision_and_firmware_files

    boolean

    required

    To include phone provision and firmware files 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.
  • backup_filename

    string

    required

    Filename for the backup.
  • include_voicemails

    boolean

    required

    To include voicemails in the backup.
  • include_system_prompts

    boolean

    required

    To include system prompts in the backup.

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/maintenance/backup \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "include_phone_provision_and_firmware_files": true,
    "include_recordings": true,
    "backup_filename": "a.zip",
    "include_call_history_records": true,
    "include_voicemails": true,
    "include_system_prompts": true
}'
                      
                    

Responses

200
Successful operation

Sample Response

                      
                      
                    

Show backup schedule

GET /backup_schedule/show
Show backup schedule
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/maintenance/backup_schedule/show \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                      
                    

Responses

200
Successful operation
application/json
  • include_phone_provision_and_firmware_files

    boolean

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

    object

    Show child attributes
  • include_recordings

    boolean

    To include recordings in the backup.
  • include_voicemails

    boolean

    To include voicemails in the backup.
  • enabled

    boolean

    Indicates if backup schedule is enabled.
  • include_call_history_records

    boolean

    To include call details records in the backup.
  • include_system_prompts

    boolean

    To include system prompts in the backup.

Sample Response

                      
{
    "include_phone_provision_and_firmware_files": true,
    "include_recordings": true,
    "include_call_history_records": true,
    "include_voicemails": true,
    "include_system_prompts": true,
    "enabled": true
}
                      
                    

Update backup schedule

POST /backup_schedule/update
Update backup schedule
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • include_phone_provision_and_firmware_files

    boolean

    required

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

    object

    required

    Show child attributes
  • include_recordings

    boolean

    required

    To include recordings in the backup.
  • include_voicemails

    boolean

    required

    To include voicemails in the backup.
  • enabled

    boolean

    required

    Indicates if backup schedule is enabled.
  • include_call_history_records

    boolean

    required

    To include call details records in the backup.
  • include_system_prompts

    boolean

    required

    To include system prompts in the backup.

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/maintenance/backup_schedule/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "include_phone_provision_and_firmware_files": true,
    "include_recordings": true,
    "include_call_history_records": true,
    "include_voicemails": true,
    "include_system_prompts": true,
    "enabled": true
}'
                      
                    

Responses

200
Successful operation

Sample Response

                      
                      
                    

Delete backup file

POST /backup_file/delete
Delete backup file
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • fileid

    string

    required

    file download id for the backup.
  • filename

    string

    required

    Filename for the backup.

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/maintenance/backup_file/delete \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{
    "filename": "a.zip",
    "fileid": "2.1asdadas"
}'
                      
                    

Responses

200
Successful operation
400
Invalid backup file name.

Sample Response