Available since version SoftSwitch 2025 and FreightSwitch 2025.


All applications bellow support trusted mode, i_customer should be supplied in that mode.


These applications provide read-only access to backup points and backup files stored by the platform.

Supported backup type filter values are: all, local, cloud, custom.

Supported date formats for start_date and end_date:

getBackupsList()


This application is used to list backup points.


Optional parameters:

  • start_date - include backups on or after the supplied date. String.
  • end_date - include backups on or before the supplied date. String.
  • enabled_type - filter backups by available file type. Possible values: all, local, cloud, custom. String. Default is all.
  • offset - skip first offset rows. Integer. Default is 0.
  • limit - return only limit rows. Integer. Default is 50. Maximum is 1000.


Returns:

  • result - OK - String.
  • backups- Array of structures with backup attributes.
    • i_backup - Backup id. Integer.
    • timestamp - Backup timestamp. DateTime.
    • total_local_size - Total size of successfully created local files inside the backup point. Integer.
    • enabled_types - Array of available backup type names for that backup point. Values are Local, Cloud, Custom.
    • status - Backup status. Possible values: Good, Has Issues, Bad. String.
  • pagination- Structure with paging attributes.
    • page - Current page number. Integer.
    • items_per_page - Requested page size. Integer.
    • total_items - Total number of matched backup points. Integer.


Status meaning:

  • Good - at least one backup file was created successfully and no failed file entries were found for that backup point.
  • Has Issues - one or more failed file entries were found for that backup point.
  • Bad - no backup files were found for that backup point.


  • XMLRPC fault in case of any error.

getBackupFilesByBackup()


This application is used to list files that belong to a selected backup point.


Required parameters:

  • i_backup - Backup id. Integer.


Optional parameters:

  • enabled_type - filter returned files by type. Possible values: all, local, cloud, custom. String. Default is all.
  • offset - skip first offset rows. Integer. Default is 0.
  • limit - return only limit rows. Integer. Default is 100. Maximum is 1000.


Returns:

  • result - OK - String.
  • backup_files- Array of structures with backup file attributes.
    • i_backup_file - Backup file id. Integer.
    • i_backup - Parent backup id. Integer.
    • filename - Backup filename or full path. String.
    • type - Stored backup file type. Possible values: local, cloud, custom. String.
    • size - File size in bytes. Integer. Negative value means the file entry represents a failed backup operation.
  • pagination- Structure with paging attributes.
    • page - Current page number. Integer.
    • items_per_page - Requested page size. Integer.
    • total_items - Total number of matched backup files. Integer.


  • XMLRPC fault in case of any error.

getBackupSummary()


This application is used to get aggregated backup summary information for the selected period.


Optional parameters:

  • start_date - include backups on or after the supplied date. String.
  • end_date - include backups on or before the supplied date. String.
  • enabled_type - limit summary calculations to files of the selected type. Possible values: all, local, cloud, custom. String. Default is all.


Returns:

  • result - OK - String.
  • backup_summary- Structure with summary attributes.
    • overall_status - Overall backup status for the selected period. Possible values: Good, Has Issues, Bad. String.
    • last_success - Timestamp of the latest successful backup point in the selected period. DateTime or null.
    • last_failure - Timestamp of the latest failed or bad backup point in the selected period. DateTime or null.
    • total_local_backup_size - Sum of successfully created local backup file sizes in the selected period. Integer.
    • enabled_types_all - Array of all backup type names found in the selected period. Values are Local, Cloud, Custom.


Note: enabled_types_all is a multi-value field. In XMLRPC response body it is serialized as a standard XMLRPC array, i.e. array/data/value nesting is expected.


  • XMLRPC fault in case of any error.