API Script Command: start_pinned_client_session

The start_pinned_client_session command attempts to start a support session with a Bomgar Jump Item. Users may run this command for all Jump Items they are permitted to access via the Jump interface in the access console.

Optional Parameters for the start_pinned_client_session Command

search_string=[string]

If specified, then this is the search criteria used to select a Jump Item. The comments, hostname, private IP, public IP, and tag fields are matched against the search string.

This field has a maximum length of 1024 characters. Search is partial and case-insensitive.

client.comments

If specified, only Jump Items with the given comments are included in the results.

This field has a maximum length of 255 characters. Search is partial and case-insensitive.

client.hostname

If specified, only Jump Items with the given hostname are included in the results.

This field has a maximum length of 255 characters. Search is partial and case-insensitive.

client.private_ip

If specified, only Jump Items with the given private IP address are included in the results.

This field has a maximum length of 255 characters. Search is partial and case-insensitive.

client.public_ip

If specified, only Jump Items with the given public IP address are included in the results.

This field has a maximum length of 255 characters. Search is partial and case-insensitive.

client.tag

If specified, only Jump Items with the given tag are included in the results.

This field has a maximum length of 255 characters. Search is partial and case-insensitive.

session.custom.[custom field]=[string]

The code name and value of any custom fields. These fields must first be configured in /login > Management > API Configuration.

Each attribute must be specified as a different parameter. Each customer field has a maximum length of 1024 characters. The maximum total size of all combined custom fields, including the external key, must be limited to 10KB.

IMPORTANT!

Either search_string or client.* parameters must be specified, but not both. It is an error to specify both the search_string and a client.* parameter. It is also an error to not specify either one.

If multiple client.* parameters are specified, then only pinned Jump Items matching all criteria are returned.

Query Examples: start_pinned_client_session

Start a session with a Jump Item which has any field containing the string "ABC"

https://access.example.com/api/client_script?type=rep&operation=generate&action=start_pinned_client_session&search_string=ABC

Start a session with a Jump Item whose hostname contains "ABCDEF02"

https://access.example.com/api/client_script?type=rep&operation=generate&action=start_pinned_client_session&client.hostname=ABCDEF02

Start a session with a Jump Item whose comments contain "maintenance" and whose tag contains "server"

https://access.example.com/api/client_script?type=rep&operation=generate&action=start_pinned_client_session&client.comments=maintenance&client.tag=server

Start a session with a Jump Item whose private IP address begins with "10.10.24" and associate custom attributes with the session

https://access.example.com/api/client_script?type=rep&operation=generate&action=start_pinned_client_session&client.private_ip=10.10.24&session.custom.custom_field1=Custom%20Value&session.custom.custom_field2=123

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