Command API

The Bomgar command API is designed to enable you to send commands to your Bomgar Appliance from an outside application. This can be used to start or transfer a Bomgar support session without using the standard representative console, to get a list of logged-in representatives, to obtain a list of support teams and issues, or to get information about your Bomgar API version. You can also check the health of your appliance or change an appliance's failover role.

Commands are executed by sending a simple HTTP request to the Bomgar Appliance. The request can be sent using any HTTPS-capable socket library or scripting language module, a web browser, or a URL fetcher such as cURL or wget. Either GET or POST may be used as the request method.

IMPORTANT! When making consecutive API calls, you must close the connection after each API call.

Note: By default, access to the API is SSL-encrypted; however, you can choose to allow HTTP access by checking the Allow HTTP Access to XML API option on the Management > API Configuration page of the /login administrative interface. It is highly recommended that HTTP remain disallowed as a security best practice.

The command API URL is https://support.example.com/api/command.

An XML schema which formally describes the format of the command API response is available at https://support.example.com/api/command.xsd.

Required Parameters for Command API
username=[string] The username to use when issuing commands. For all commands except get_api_info, this user must have permission to use the command API. The user must have permission to perform remote support in order to issue generate_session_key and must be an administrator in order to issue join_session, set_session_attributes, get_session_attributes, terminate_session, transfer_session, check_health, or set_failover_role.
password=[string] The password associated with this username.
action=[string] The type of action to perform. Can be get_logged_in_reps, get_support_teams, generate_session_key, join_session, transfer_session, set_session_attributes, get_session_attributes, terminate_session, get_appliances, get_connected_client_list, get_connected_clients, check_health, set_failover_role, or get_api_info.

IMPORTANT! If you are experiencing a high volume of support requests, repeatedly calling a command such as get_logged_in_reps or get_support_teams can potentially bottleneck your system. Therefore, a best practice is not to request a list of representatives or teams with each support request. Instead, if you are making the same API call in succession, consider caching the results for a period of time and reusing them. New sessions requests should reference this cached list instead of calling for the list each time.

Starting with Bomgar 14.1, the command API returns XML responses that declare a namespace. If you are parsing these responses with a namespace-aware parser, you will need to set the namespace appropriately or ignore the namespace while parsing the XML.

  • Command API: http://www.bomgar.com/namespaces/API/command

Note: The above namespace is returned XML data and is not a functional URL.

IMPORTANT! If you have been using the API prior to 14.1, this change could break backward compatibility with existing integrations if namespaces are not handled properly. If possible, be sure to test your code against a site running Bomgar 14.1.1 or higher before upgrading.