sFTP Push
Photo Collect can push any files, including photos, variants, and signatures, to a remote sFTP server provided by the customer.
Only sFTP over SSH is supported for secure file transfers. FTPS (FTP over TLS) is not supported.
Choosing between sFTP Push and GET /export
sFTP Push and GET /export should not be combined. Choose one delivery method for your integration. Files are deleted from Photo Collect immediately after a successful sFTP transfer, so they will no longer be available through GET /export.
| Delivery method | Behavior and data |
|---|---|
| sFTP Push | Transfers files to your server immediately after export. |
GET /export |
Your application retrieves exported files through the API, together with metadata such as user consent, timestamps, and user contact data. |
Remote directory structure
- Dedicated instances: Photos can be pushed to a specified remote directory, preserving the site structure if required.
- Cloud setups: All files belonging to the tenant are pushed to a single remote directory.
Connection details
Provide the following details to configure sFTP Push:
| Setting | Description |
|---|---|
| Hostname | The hostname of your sFTP server. |
| Port | The sFTP port. The default is 22. |
| Remote directory | The destination directory on your server. |
| Username | The account used to connect to your server. |
Authentication
We support username/password authentication and SSH keypair authentication.
SSH keypair authentication is preferred. We create the keypair and share the public key with you to authorize on your sFTP server.
If you choose username/password authentication, provide the password for the configured account.
Transfer and deletion
Files are pushed directly after the export. If the push fails, the export is retried until the transfer succeeds.
We delete the files from Photo Collect immediately after a successful transfer. The transferred files remain on your sFTP server.