Configuration API

The Configuration API lets external applications manage and automate the configuration of BeyondTrust Remote Support. You can use it to create, update, retrieve, and delete configuration objects programmatically.

The Configuration API is available as an OpenAPI specification, allowing you to view and interact with the API using tools such as Swagger UI, Postman, or Redoc.

Authenticate to the API

To use the Configuration API, you must have an API account with Configuration API access and authenticate using OAuth 2.0.

ℹ️

For instructions on creating an API account, see Authenticate to the API.

Access the API documentation

Browse the API reference to view available endpoints, request and response schemas, authentication requirements, and examples.

Access the Configuration API documentation in any of the following ways:

• In the /login interface:
  1. Go to Management > API Configuration.
  2. Click View the Configuration API Documentation.
• Using an OpenAPI-compatible tool:
  1. Go to Management > API Configuration.
  2. Click Download the Configuration API's OpenAPI YAML file.
  3. Import the YAML file into your preferred tool.
• Read the Configuration APIs documentation in the pages below.