Backup API

The Bomgar backup API is designed to enable you to automatically back up your Bomgar software configuration on a recurring basis. The backup file will include all your configuration settings and logged data except for recordings and some large files from the file store. The backup will only include files from the file store less than 200 KB in size and no more than 50 files total. In the event of a hardware failure, having a backup file will help to speed the disaster recovery process.

Commands are executed by sending a simple HTTP request to the Bomgar Appliance. The request can be sent using any HTTPS-capable socket library or scripting language module, a web browser, or a URL fetcher such as cURL or wget. Either GET or POST may be used as the request method.

Note: By default, access to the API is SSL-encrypted; however, you can choose to allow HTTP access by checking the Allow HTTP Access to XML API option on the Management > API Configuration page of the /login administrative interface. It is highly recommended that HTTP remain disallowed as a security best practice.

The backup API URL is https://support.example.com/api/backup.

Required Parameters for Backup API

username=[string] The username to use when backing up the support site. Must be an administrator.
password=[string] The password associated with this username.

Query Example

backup https://support.example.com/api/backup?username=test&password=test