The backup API is designed to enable 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 files from the file store only 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.
The backup API is an authenticated API. For instructions on using authenticated APIs using OAuth, see Authenticate to the Privileged Remote Access API. The API account used to issue this command must have access to the backup API.
Commands are executed by sending a simple HTTP request to the Secure Remote Access 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.
The backup API URL is https://access.example.com/api/backup.
Prior to 16.1, a user account was used to authenticate to the API, with the username and password being passed in the request. Starting with 16.1, this method has been deprecated and is not available to new users. Instead, one or more API accounts must be created, with their client IDs and client secrets used to generate OAuth tokens.
For users upgrading from a version prior to 16.1, the option to authenticate to the API with a user account is still available for backwards compatibility. However, it is highly recommended that you use the more secure OAuth method of authentication. If you are unable to switch to OAuth authentication, please follow the API request format described in our documentation archive.