API configuration

What is API configuration?

API configuration involves setting up the application programming interface (API) to allow secure and efficient communication between the B Series Appliance and external systems, enabling integration with other services.

How is API configuration useful for the B Series Appliance?

API configuration allows administrators to automate tasks, integrate third-party tools, and extend the functionality of the B Series Appliance, improving workflows and streamlining operations.

How do I access the API Configuration page?

1. Sign into app.beyondtrust.io.
   The BeyondTrust Home page displays.
2. From the left menu, click Remote Support > Management.
   The Management page opens and the Software tab displays by default.
3. At the top of the page, click API Configuration.
   The API Configuration page displays.

How to enable the API and set up access

Enable XML API

Choose to enable the BeyondTrust XML API, allowing you to run reports and issue commands such as starting or transferring sessions from external applications, as well as to automatically back up your software configuration.

ℹ️

Note

Only the Command, Reporting, and Client Scripting API calls are enabled/disabled by this setting. Other API calls are configured under Public Portals.

ℹ️

Note

For more information, please see the API guide.

CLI client download

The CLI (Command Line Interface) tool can be downloaded to make it easier to use and configure APIs and automation scripts, and integrate them with your BeyondTrust Remote Support installation. The CLI tool is available for Windows (x64), macOS, and Linux (x64) platforms. Select the appropriate platform and click Download BTAPI CLI Client.

The download is a compressed executable file. Extract the file, and save or link it from an executable area (in your PATH).

• For Windows systems: Open the file in a terminal such as Windows Command Prompt or Windows PowerShell.
• For macOS systems: Run the file in the terminal.

The Help information, including options, commands, and variable instructions, displays when the program opens.

ℹ️

Note

For more information on creating APIs with CLI, please see Use cases examples in the BeyondTrust Remote Support API Guide

Enable archive API

Choose to enable the state archive API to download logs of the B Series Appliance's state and of events that occurred on a given date.

Allow HTTP access to XML API

Allow the API to be accessed via HTTP.

Allow HTTP access to XML API

Allow the API to be accessed via HTTP.