Remote Support API programmer's guide

Version 1.24.1 (for BeyondTrust Remote Support 24.3.x)

Front-end integration of the BeyondTrust API enables customers to integrate Remote Support support sessions with third-party or in-house developed applications to pull report data, issue commands, or automatically save backups of the B Series Appliance's software configuration.

One common use case of an API integration is linking a help desk ticketing system to Remote Support sessions to track issue resolution.

You could also add a feature to an application so that a representative can generate a session from within that application instead of the representative console.

Management > API Configuration Options in Remote Support /login.

To use the BeyondTrust API, ensure that the Enable XML API option is checked on the Management > API Configuration page of the /login administrative interface.

For some examples in this guide, URLs such as support.example.com are used. Please replace this URL with your B Series Appliance’s public site URL.

The command and reporting APIs return XML responses that declare a namespace. If you are parsing these responses with a namespace-aware parser, you must set the namespace appropriately or ignore the namespace while parsing the XML.

  • Reporting API: https://www.beyondtrust.com/namespaces/API/reporting
  • Command API: https://www.beyondtrust.com/namespaces/API/command

The above namespaces are returned XML data and are not functional URLs.

CLI tool

A Command Line Interface (CLI) tool can be downloaded from the administrative interface. The CLI tool makes it easier to use and configure APIs and automation scripts, and integrate them with your BeyondTrust Remote Support installation.

For more information on downloading and installing the CLI Tool, please see API Configuration in the BeyondTrustRemote Support Admin Guide.