Command API

The command API is designed to send commands to your BeyondTrust site from an outside application. Commands can get or set session attributes, join an existing session, or terminate a session. You can also check the health of your B Series Appliance or get information about your BeyondTrust API version.

Commands are executed by sending an HTTP request to the B Series Appliance. Send the request using any HTTPS-capable socket library, scripting language module, or URL fetcher such as cURL or wget. Use either GET or POST as the request method.

POST requests must include a "Content-Type: application/x-www-form-urlencoded" HTTP header when supplying parameters in the request body, and the parameters must be url-encoded. Multipart POST requests are not supported.

 

When making consecutive API calls, you must close the connection after each API call.

The command API URL is https://access.example.com/api/command.

The command API is an authenticated API. For instructions on using authenticated APIs using OAuth, please see Authenticate to the Privileged Remote Access API.

Required Parameter for Command API

action=[string]

The type of action to perform. Can be join_session, set_session_attributes, get_session_attributes, import_jump_shortcut, terminate_session, check_health, set_failover_role, or get_api_info.

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.beyondtrust.com/namespaces/API/command

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