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 BeyondTrust API. |
| <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
| 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_configuration | Integer value (1 or 0) indicating if the API account has permission to use the Configuration API. |
| perm_configuration_vault_account | Integer value (1 or 0) indicating if the API account has permission to manage Vault accounts via the Configuration API. |
| perm_ecm | Integer value (1 or 0) indicating if the API account can be used by an Endpoint Credential Manager client to connect to the appliance. |
| perm_real_time_state | Integer value (1 or 0) indicating if the API account has permission to use the Real-Time State API. |
| 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. |
| perm_reporting_vault | Integer value (1 or 0) indicating if the API account has permission to run Vault Activity reports. |
| perm_vault_backup | Integer value (1 or 0) indicating if the API account has permission to backup the Vault encryption key, the key used to encrypt and decrypt all the Vault credentials stored on the appliance. |
Query example: get_api_info
| get_api_info |
https://support.example.com/api/command?action=get_api_info |
