Project SFTP access

Use SFTP access to connect an SFTP client to a project's files in an environment. Enabling access creates an sftp folder in the project's File Manager and generates a private key for authentication.

Access is configured separately for each project in the environment. The SFTP connection is restricted to that project's SFTP folder.

Open the SFTP settings

1. Open the project in the environment where you want to manage SFTP access.
2. Select Settings under Manage.
3. Select File access from the settings menu.

The File access section is available in an environment. It does not appear in the Designer. If the project has not been deployed yet, see Deploy and update projects.

Your account needs access to the project and its settings. If you cannot enable or disable SFTP access, the switch is disabled and its tooltip asks you to contact your manager. See Roles and restrictions for general access information.

Enable SFTP access

1. Turn on the SFTP access switch.
2. Review the Enable SFTP access? confirmation.
3. Select Enable.

warning

Enabling SFTP restarts the SFTP service for the environment and may interrupt active file transfers in other projects. It also generates a new SFTP key.

After a successful request, the status changes to SFTP enabled. The Authentication and Connection Details sections become available. The confirmation applies the change immediately; you do not need to select Save for this action.

Download the private key and connect

1. Under Authentication, select Download private key.

2. Store the downloaded key securely.

3. Configure your SFTP client with the values shown under Connection Details:

   Setting	Value to use
   Host	The host displayed for this environment.
   Port	The port displayed in the settings.
   Protocol	SFTP.
   Username	The username displayed for the project.
   Authentication method	Private key only, using the downloaded key.

4. Connect with the client. The SFTP upload directory is /upload, which corresponds to the project's sftp folder in File Manager.

The copy controls beside Host, Port, Protocol, and Username let you copy those values. Only private key authentication is supported.

Files transferred to /upload are stored in the project's sftp folder. Open File Manager to manage those files from Flowize.

Disable SFTP access

1. Return to Settings > File access in the project.
2. Turn off the SFTP access switch.
3. Review the Disable SFTP access? confirmation.
4. Select Disable.

warning

Disabling SFTP restarts the SFTP service for the environment and may interrupt active transfers in other projects. It invalidates the project's current SFTP key and stops active SFTP connections to the project.

After a successful request, the status changes to SFTP disabled, and the authentication and connection details are hidden. The change takes effect without selecting Save.

Disabling access removes the project's SFTP keys. It keeps the sftp folder and its files in File Manager.

Re-enable access

To restore access, turn on the switch and confirm with Enable again. Download the new private key and update any clients that used the previous key. The previous key is no longer valid.

Re-enabling access keeps the existing sftp folder and its files. As with the initial enable action, it restarts the environment's SFTP service.

When a key download is unavailable

The private key download requires active SFTP access and an available private key. Otherwise, Flowize displays SFTP private key is not available for this project.

If you cancel an enable or disable confirmation, the switch returns to its previous state and the action is not applied.