API Script Command: start_pinned_client_session

The start_pinned_client_session command attempts to start a support session with a Bomgar Jump Client. Representatives may run this command for all Jump Clients they are permitted to access via the Jump Client management interface in the representative console.

Required Parameters for the start_pinned_client_session Command

search_string =[string] The search criteria used to select a Jump Client. The private IP, public IP, hostname, and comments fields of the Jump Client will be matched against the search string. This field has a maximum length of 1024 characters.

Optional Parameters for the start_pinned_client_session Command

session.custom.external_key =[string] The external key to associate with the support session spawned from the Jump Client. This field has a maximum length of 1024 characters.

Query Examples: start_pinned_client_session

Start a support session with the Jump Client whose hostname is "ABCDEFGH02" https://support.example.com/api/client_script?type=rep&operation=generate&action=start_pinned_client_session&search_string=ABCDEFGH02
Start a support session with the Jump Client whose comments field contains the string "Example Co"

https://support.example.com/api/client_script?type=rep&operation=generate&action=start_pinned_client_session&search_string=Example%20Co

or

https://support.example.com/api/client_script?type=rep&operation=generate&action=start_pinned_client_session&search_string=Example+Co

Start a support session with the Jump Client whose private IP address or public IP address is "192.168.9.14" and assign the external key "BMC0000001275" to the session: https://support.example.com/api/client_script?type=rep&operation=generate&action=start_pinned_client_session&search_string=192.168.9.14&session.custom.external_key=BMC0000001275

Note: If more than one Jump Client matches the search criteria then a dialog will open , giving the user the option to select the appropriate Jump Client.