Protocol URL Addresses

To register WinSCP to handle the URL addresses use installer or go to Preferences dialog.

If current user’s permissions allow, WinSCP register itself for all users. Otherwise it registers for current user only.

On Windows Vista, 7 and 8, WinSCP registers to list of applications that handle sftp://, ftp://, ftps:// and scp:// protocol URL addresses. If WinSCP is the first application to support some of these protocols (most often sftp:// and scp://, usually also ftps://), it becomes a default application for these.

If you want to change the registration (for instance to make WinSCP default application even for ftp:// URL addresses):

• On Integration page of Preferences dialog go to Register to handle URL addresses > Make WinSCP default handler1;
• Set Program Associations Control Panel applet for WinSCP opens;
• Check protocols you want WinSCP to be the default application for;
• and confirm with Save button.

Note that most mainstream web browsers ignore system registration for ftp:// URL addresses and handle these on web pages on their own. To override this, you may use WinSCP-specific URL addresses.

On Windows XP, WinSCP registers to handle sftp:// and scp:// protocol URL addresses, overriding previous registration, if any.

To change the registration:

• Go to Control Panel > Folder Options > File Types;
• Search a list for File types “URL: SFTP Protocol” or “URL: SCP Protocol”;
• Click Advanced button;
• Select “open” action;
• Click Edit button.

In addition to registering to generic URL protocols, WinSCP registers for application-specific URL protocols with winscp- prefix, i.e. winscp-sftp://, winscp-ftp://, etc. This is particularly useful for FTP protocol, for which WinSCP competes with your default web browser. Also for links on web pages, web browsers typically ignore system registration for ftp:// addresses and handle these on their own anyway.

Using WinSCP-specific URL protocols is reasonable also, when using WinSCP-specific extension for URL syntax, particularly the save extension.

If a handled URL does not include path part, WinSCP simply opens a session specified by the URL.

If path part is included and it ends with slash (/), WinSCP starts with the path as initial remote directory. If the path part does not end with slash, the file (or directory) specified by it is downloaded.

To make WinSCP save session settings provided by URL to a site instead of opening a session, add ;save after a path part of the URL (it there is no path part, terminate the URL with / before adding the ;save extension).

For SFTP/SCP URL this should be combined with including SSH host key fingerprint in the URL. As this is WinSCP-specific extension, and also to avoid conflicts with other applications, like web browsers, consider using WinSCP-specific URL protocols.

Example: winscp-sftp://martin:mypassword;fingerprint=ssh-rsa-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx-xx@example.com/;save

You can have WinSCP generate URL using:

• Manage > Generate URL command on Login dialog to generate session URL for selected site.
• Session > Generate URL command on main window to generate session URL for current session.
• File(s) > File Names > Generate URL command on main window to generate file URL for files selected in remote file panel.

This feature is available only in the latest beta release.