Command API

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

Commands are executed by sending an HTTP request to the appliance. Send the request using any HTTPS-capable socket library or scripting language module, web browser, or URL fetcher such as cURL or wget. Use either GET or POST 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 describing the command API response format is available at https://support.example.com/api/command.xsd.

Required Parameters for Command API
username=[string] The username to use to issue 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 to issue generate_session_key and must be an admin 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 experience a high volume of support requests, repeatedly calling a command such as get_logged_in_reps or get_support_teams might bottleneck your system. Therefore, a best practice is not to request a list of representatives or teams with each support request. Instead, if making the same API call in succession, consider caching the results for a period of time and reusing them. New sessions requests should reference the 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 need to set the namespace appropriately or ignore the namespace while parsing the XML.

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

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

IMPORTANT!

If you started using the API prior to 14.1, this change could break backward compatibility with current integrations if namespaces are not handled properly. If possible, test your code on a site running Bomgar 14.1.1 or up before upgrading.