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 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 can be used by an Endpoint Credential Manager client to connect to the appliance. |
| perm_configuration_vault_acount | 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_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_reporting | Integer value (1 or 0) indicating if the API account has permission to use the reporting API. |
| perm_reporting_license | Integer value (1 or 0) indicating if the API account has permission to download a ZIP file containing the Endpoint License Usage Report. |
| perm_reporting_vault | Integer value (1 or 0) indicating if the API account has permission to download a ZIP file containing the Endpoint License Usage Report. |
| perm_vault_backup | Integer value (1 or 0) indicating if the API account has permission to download a ZIP file containing the Endpoint License Usage Report. |
| perm_scim | Integer value (1 or 0) indicating if the API account has permission to use the SCIM API. |
Query Example: get_api_info
| get_api_info |
https://access.example.com/api/command?action=get_api_info |
