Skip to content

SFTP Data Transfers

To make it easier to use standard tools to add files to a project, it is possible to configure and use SFTP to transfer files into a project.


The SFTP service uses SSH public key authentication to authenticate a SFTP user. To get started, you need to first generate a public/private key pair. Use console tools like ssh-keygen.

ssh-keygen -P "" -f my_key

Creating a SFTP User

  1. On the left side menu of PHC, click Files and SFTP.
  2. Click the Add User. Add SFTP User The Add New User dialog displays. Use the following information to fill in the fields:
Field Description
Username This is the username that authenticates with the SFTP service. Note that the PHC account name is added as a prefix to the value provided.
Home Directory You may want to restrict where a SFTP user can add files within a project. You can do this by specifying a specific folder to use in the project as the user's home directory. The SFTP user will not be able to add files to any other location within the project.
SSH Key Name A user-friendly name to identify the key
SSH Public Key The public key portion of the public/private key pair

3. Click the Add User button on the dialog.

Once the user is created, PHC shows instructions to access the SFTP service.

sftp -i ./my_key

Add SFTP User

Once connected, you can transfer files into the project using standard SFTP commands.


PHC SFTP is restricted to Write Access.

Review Audit Access and Event History

You can review SFTP access event history from the PHC web console.

  1. On the left side menu of PHC, click Files and SFTP.
  2. Under Username, click on a user to display the SFTP User details view.
  3. From the SFTP User details view, click on the Event History tab. This tab shows a listing of events for the SFTP user. This includes events for when the user connected, which files were added, and when they disconnected. SFTP User Events

Delete SSH Keys

A single SFTP user can have up to five SSH keys registered at one time.

For security, we recommend that you rotate your SSH keys. A time interval of three months is a common rotation period.

If you think that a user's private key has been compromised, you can remove it from the list of keys on the SFTP User details view. Once removed, that private key can no longer be used to access the SFTP service.

  1. Under Username, click on a user to display the SFTP User details view.
  2. Click the Settings tab.
  3. Under SSH Keys, click Delete next to the specific key. Add SFTP Delete

Last update: 2021-10-06
Created: 2020-05-28