API Command: get_api_info

The get_api_info request returns XML data containing the current API version information.

XML Response for get_api_info Query

<api_version> The software version of the current Bomgar API.
<timestamp> The server’s current timestamp at the time this report was pulled.
<permissions> The permissions of the user account used to issue this command. The permissions shown are detailed below.
<user_id> The numeric rep ID of the Bomgar user making this API call.

Element Names and Attributes

/get_api_info/permissions/permission
perm_use_command_api Integer value (1 or 0) indicating if the user has permission to use the command API.
perm_use_reporting_api Integer value (1 or 0) indicating if the user has permission to use the reporting API.
perm_admin Integer value (1 or 0) indicating if the user is an administrator.
perm_view_reports

Indicates if the user has permission to view reports. Can be one of the following:

none Cannot view any reports.
user_sessions Can view reports in which he or she was the primary representative.
team_sessions Can view reports in which one of the user's teammates was the primary representative or one of the user's teams was the primary team.
all_sessions Can view all reports.
perm_view_sd_recordings Integer value (1 or 0) indicating if the user has permission to view support session recordings.
perm_sd_allowed Integer value (1 or 0) indicating if the user is allowed to provide remote support.

Query Example: get_api_info

get_api_info https://support.example.com/api/command?username=test&password=test&action=get_api_info