API version reference and change log

Version reference

The following table shows the relationship between the API and BeyondTrust versions for BeyondTrust Privileged Remote Access.

API changelog

API version 1.24.1 for PRA 24.3.x

• Reporting API
  • Added JumpItem query.

API version 1.24.1 for PRA 24.1.x

• Configuration API:
  • Force the logging out of users - perfect for automating security around anomaly detection.
  • List user group policy membership to programmatically control access.

API version 1.23.1 for PRA 23.3.x

• Configuration API:
  • Added "Windows Local" and "Domain" accounts and attributes to the Vault Account configuration API (GET).
  • Added an endpoint filter to the Vault Account configuration API (GET).

API version 1.22.3 for PRA 23.2.x

• Configuration API:
  • Added Jump Item Association.
  • Added VNC Jump Items.
  • Added Account Group Memberships to Group Policies.
  • Added reactivating vendor users.
  • Added return all API accounts and permissions.
  • Added return user permissions.
• Reporting API:
  • Added download syslog zip files from the appliance.

API version 1.22.2 for PRA 22.3.x, 21.1.x

• Configuration API:
  • Added GET, PATCH, and DELETE APIs for the Protocol Tunnel Jump Item type.
  • Added GET and PATCH APIs to allow administrators to update the available groups for existing SAML Security Provider resources.

API version 1.22.2 for PRA 22.2.x

• Configuration API:
  • Enhanced Group Policy Configuration APIs (GET, POST, and PATCH) to allow administrators to read and set access permission settings.

API version 1.22.1 for PRA 22.1.x

• Command API:
  • Added perm_reporting_license.

API version 1.21.1 for PRA 21.2.x

• Command API:
  • Added set_rep_status.
  • Expanded send_chat_message to allow sending messages to team chats.
• Configuration API:
  • Enhanced Web Jump Shortcut API to enable administrators to manage Web Jump Shortcuts via API.
  • Enhanced Copy Jump Item API to enable administrators to copy Jump Items via API.

API version 1.19.2 for PRA 20.1.x

• Added the Configuration API.

API version 1.19.0 for PRA 19.1.x

• Version update.

API version 1.18.0 for PRA 18.2.x

• SCIM options have been added to the API Configuration.

API version 1.16.0 for PRA 17.1.x

• Use OAuth 2.0 authentication for endpoint credential manager connections.
• When importing a Jump Item several changes have been made:
  • Specify a name for Jump Items.
  • Import VNC Jump Items.
  • Specify a SecureApp for RDP Jump Items.
  • Specify a local address for Protocol Tunnel Jump Items.
  • For Web Jump Items, set if the certificate should be verified.
  • API command: import_jump_shortcut

API version 1.15.1 for PRA 16.1.x

• Granularly define the accounts used for API access to the specific roles they serve. Additionally, OAuth 2.0 authentication is now used for authenticating API accounts.
  • Reporting API
  • Command API
  • Backup API

API version 1.14.0 for PRA 15.3.x

• Import Jump Item shortcuts to minimize the time needed to create Jump Items.
  • API command: import_jump_shortcut