API Command: get_api_info

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

The command API is an authenticated API. For instructions on using authenticated APIs using OAuth, see Authenticate to the Remote Support API. The API account must have read-only or full access to the command API.

XML Response for get_api_info Query

<api_version> The software version of the current Bomgar API.
<company_name> The Company API Name listed on the Status > Information page of the /login administrative interface.
<timestamp> The server’s current timestamp at the time this report was pulled.
<permissions> The permissions of the API account used to issue this command. The permissions shown are detailed below.

Element Names and Attributes

/get_api_info/permissions/permission
perm_backup Integer value (1 or 0) indicating if the API account has permission to use the backup API.
perm_command String indicating if the API account has full access to the command API, read_only access, or no access (deny).
perm_reporting_archive Integer value (1 or 0) indicating if the API account has permission to use the archive reporting API.
perm_reporting_license Integer value (1 or 0) indicating if the API account has permission to use the license usage reporting API.
perm_reporting_presentation Integer value (1 or 0) indicating if the API account has permission to use the presentation session reporting API.
perm_reporting_support Integer value (1 or 0) indicating if the API account has permission to use the support session reporting API.

Query Example: get_api_info

get_api_info
  • https://support.example.com/api/command?action=get_api_info