URL handler

You can create URLs that follow a specific format, which causes the Advanced Server Access URL handler to be invoked when the URL is clicked. The client then takes the information passed from the URL handler and attempts to connect to the target server. These URLs are often used for daily interfaces such as dashboards, ticketing and monitoring systems, and logs.

Setup

Use the following template to set up your URL handler:

scaleft://[<sft-username>@]app.scaleft.com/t/<team>/a/<target>/<access-method>?via=[<username>@]<bastion>

Note: All information in square brackets [ ] is optional.

Parameter values

The following table lists the parameters for a URL handler, and what values are acceptable for them.

Parameter Value
<sft-username> (Optional) The Advanced Server Access user name to use to connect to the instance.
<access-method>

One of:

  • ssh
  • rdp
<target>

A server name that Advanced Server Access resolves. See Server name resolution.

via (Optional) This section of the URL handler is only needed if no bastion configuration exists. If you need to include multiple bastion configurations in the URL, then multiple via parameters are required and they must be in the correct order.
<username> (Optional) For hops that aren't managed by Advanced Server Access, a username might need to be specified for that bastion.

Examples

The following are examples of URL handlers:

  • scaleft://app.scaleft.com/t/okta-demo-only/a/ubuntu-target/ssh
  • scaleft://app.scaleft.com/t/okta-demo-only/a/ubuntu-target/ssh?via=ubuntu-bastion

Check for correct URL handling

You can verify that the URL handlers are working as expected by checking the Advanced Server Access client logs, which log both clicks and the handling of the URL.

If you're using a Windows machine, the client logs are located in c:\users\<username>\appdata\local\scaleft\logs.

If you're using a Mac, the client logs are located in ~/Library/Logs/ScaleFT/sft/.