Backup API

The backup API enables you to automatically back up your BeyondTrust software configuration on a recurring basis. The backup file includes all your configuration settings and logged data except for recordings and some large files from the file store. The backup includes only 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 helps to speed the disaster recovery process.

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

If the backup is password protected, you can send the password in the API body, in this format:

{
  "password": "abc"
}

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

ℹ️

Note

The backup API is an authenticated API. The API account used to issue this command must have access to the backup API.

For instructions on using authenticated APIs using OAuth, see Authenticate to the API.

Query example

• Back up the software

https://support.example.com/api/backup