API Change Log

API Version 1.24.1 for RS 24.1.x

Configuration API:
- Force the logging out of users - great if building API connectors leveraging anomaly detection.
- List user group policy membership, making it easier to control access programmatically.

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).

Reporting API:
- Added Syslog query. This downloads a ZIP file containing all Syslog files available on the appliance. Syslog files include all changes made on the /login administrative interface within the last 30 days.

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.

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

Version update
Expanded EndpointLicenseUsage to make it possible to download a ZIP file containing detailed information (English only) on BeyondTrust license usage.

Version update
Expanded the current send_chat_message Command API operation to send a chat message to Team Chats.
Added an API that copies the existing Jump Client resource with the given <id>.
Added command API: set_rep_status to set the status for representatives logged into the representative console.

Use OAuth 2.0 authentication for the real-time state API and 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 local address for Protocol Tunnel Jump Items.
- For Web Jump Items, set if the certificate should be verified.
- API Command: import_jump_shortcut

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.
Specify the timezone offset of a generated session so that the customer client can be downloaded from the nearest traffic node of an Atlas cluster, resulting in faster session start times.
- Session Generation API

Import multiple shortcuts using the import_jump_shortcuts command.
- API Command: import_jump_shortcut
Use the Presentation Archive API to view presentation event data.
- Download Reports with PresentationSession
- Download Reports with PresentationSessionListing
PresentationRecording has been deprecated in favor of PresentationSessionRecording. PresentationRecording is still available for backward compatibility.
- Download Reports with PresentationSessionRecording
A JavaScript library with the ability to interact with the BeyondTrust real-time state API has been implemented.
- JavaScript Library for the Real-Time State API

Use the Archive API to view session event data.
- Download Reports with Archive
View the Company API Name in the XML output of the get_api_info Command API operation.
- API Command: get_api_info

Use BeyondTrust Representative Console Scripts to start sessions through Jumpoints, start RDP sessions, or start Shell Jump sessions.
Add custom session attributes to sessions started with a BeyondTrust Representative Console Script.
View real-time data for support center activity in your organization.
- Real-Time State API
View archives of the system state of your BeyondTrust Appliance B Series to analyze support center activity in your organization.
- Download Reports with ArchiveListing
- Download Reports with Archive

The file extension .ns has been deprecated from the API calls. It is still available for backward compatibility.
- https://support.example.com/api/command.ns is now https://support.example.com/api/command
- https://support.example.com/api/client_script.ns is now https://support.example.com/api/client_script
- https://support.example.com/api/start_session.ns is now https://support.example.com/api/start_session
- https://support.example.com/api/reporting.ns is now https://support.example.com/api/reporting
- https://support.example.com/api/backup.ns is now https://support.example.com/api/backup
Use two new API commands to help automate failover.
- API Command: check_health
- API Command: set_failover_role
Set custom session attributes when starting or during a session. Customer details, skills, and custom fields can now be added to sessions regardless of session start type (session key, rep selection, issue submission). Additionally, certain fields have been deprecated in favor of a more consistent format. All fields are still available for backward compatibility. Deprecated fields are noted in their respective sections.
Retrieve custom session attributes during a session.
- API Command: get_session_attributes

Use three new commands to view information about your BeyondTrust Appliance B Series and connected software clients.

Download reports of license usage data.

Command and reporting APIs return XML that declare a namespace.

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

Specify the language to use for the customer client.