SFTP (SSH File Transfer Protocol) is a network protocol that provides file access, file transfer, and file management over any reliable data stream. It was designed by the Internet Engineering Task Force (IETF) as an extension of the Secure Shell protocol (SSH) version 2.0 to. Dec 01, 2020 What is SFTP? SFTP stands for Secure File Transfer Protocol (also known as SSH File Transfer Protocol). It is a file transfer protocol such as FTP yet operates over a secure network protocol like SSH. We highly recommend using SFTP for file transferring because: It adds a layer of security. Transferred data is encrypted, so it is not sent in. SFTP stands for Secure File Transfer Protocol (also known as SSH File Transfer Protocol). It is a file transfer protocol such as FTP yet operates over a secure network protocol like SSH. We highly recommend using SFTP for file transferring because: It adds a layer of security. Transferred data is encrypted, so it is not sent in.
-->SFTP (SSH File Transfer Protocol) is a network protocol that provides file access, file transfer, and file management over any reliable data stream. It was designed by the Internet Engineering Task Force (IETF) as an extension of the Secure Shell protocol (SSH) version 2.0 to provide secure file transfer capabilities.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions and Integration Service Environments (ISEs) |
| Power Automate | Standard | All Power Automate regions except the following: - US Government (GCC High) |
| Power Apps | Standard | All Power Apps regions except the following: - US Government (GCC High) |
| Contact | |
|---|---|
| Name | Microsoft |
| URL | Microsoft LogicApps Support Microsoft Power Automate Support Microsoft Power Apps Support |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
Trigger limits
The triggers work by polling the SFTP file system, and looking for any file which has been modified since the last poll, comparing files by modification time. Certain tools allow the file modification time to be preserved. In such cases, you need to disable the feature for your trigger to work. Here are some common settings:
| SFTP client | Action |
|---|---|
| WinSCP | Options → Preferences… → Transfer → Edit… → Preserve timestamp → Disable |
| FileZilla | Transfer → Preserve timestamps of transferred files → Disable |
When the triggers encounter a new file, it will try to ensure that the new file is completely written. For instance, it is possible that the file is being written or modified, and updates are being made at the time the trigger polled the file server. To avoid returning a file with partial content, the trigger will take note of the timestamp such files which are modified recently, but will not immediately return those files. Those files will be returned only when the trigger polls again. Sometimes, this may lead a delay up to twice the trigger polling interval. This also means that the trigger does not guarantee to return all files in a single run when 'Split On' option is disabled.
Connector in-depth
For more information about the connector, see the in-dept section.
Creating a connection
The connector supports the following authentication types:
| Default | Required parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Required parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description |
|---|---|---|
| Host server address | string | Host server address |
| User name | string | User name |
| Password | securestring | Password |
| SSH private key | securestring | SSH private key (the content of the file should be provided entirely as is, in the multiline format) |
| SSH private key passphrase | securestring | SSH private key passphrase (if the private key is protected by a passphrase) |
| Port number | int | SFTP port number (example: 22) |
| Disable SSH host key validation | bool | Disable SSH host key validation? (True/False) |
| SSH host key finger-print | string | SSH host key finger-print |
| Root folder path | string | Root folder path. |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 150 | 60 seconds |
Actions
| Copy file | This operation copies a file. |
| Create file | This operation uploads a file. |
| Create folder | This operation creates a new folder. |
| Delete file | This operation deletes a file. |
| Extract archive to folder | This operation extracts an archive file into a folder (example: .zip). |
| Get file content | This operation gets file contents using the file id. |
| Get file content using path | This operation gets file contents using the file path. |
| Get file metadata | This operation gets file metadata using the file id. |
| Get file metadata using path | This operation gets file metadata using the file path. |
| List files in folder | This operation gets files contained in a folder. |
| List files in root folder | This operation gets the files in the root folder. |
| Rename File | This operation renames a file. |
| Update file | This operation updates the file content. |
Copy file
This operation copies a file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| source | True | string | Path to the source file | |
Destination file path | destination | True | string | Path to the destination file, including file name |
| overwrite | boolean | Overwrites the destination file if set to 'true' | ||
Get all file metadata | ReadFileMetadataFromServer | boolean | Get all file metadata from the SFTP server after file creation is complete. If this is false, some metadata properties may not be returned such as last modified time, etc. |
Returns
Blob metadata
Create file
This operation uploads a file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| folderPath | True | string | Unique path of the folder | |
File name | name | True | string | Name of the file |
| body | True | binary | Content of the file to create | |
Get all file metadata | ReadFileMetadataFromServer | boolean | Get all file metadata from the SFTP server after file creation is complete. If this is false, some metadata properties may not be returned such as last modified time, etc. |
Returns
Blob metadata
Create folder
This operation creates a new folder.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| folderPath | True | string | Select a folder | |
Name | name | True | string | Name of the folder |
Returns
Blob metadata
Delete file
This operation deletes a file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| id | True | string | Specify the file | |
Skip delete if file not found | SkipDeleteIfFileNotFoundOnServer | boolean | Skips deletion if a file is not found without failing action. |
Extract archive to folder
This operation extracts an archive file into a folder (example: .zip).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| source | True | string | Path to the archive file | |
Destination folder path | destination | True | string | Path to the destination folder |
| overwrite | boolean | Overwrites the destination files if set to 'true' |
Returns
- response
- array of BlobMetadata
Get file content
This operation gets file contents using the file id.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| id | True | string | Specify the file id | |
Infer Content Type | inferContentType | boolean | Infer content-type based on extension |
Returns
The content of the file.
Get file content using path
This operation gets file contents using the file path.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| path | True | string | Unique path of the file | |
Infer Content Type | inferContentType | boolean | Infer content-type based on extension |
Returns
The content of the file.
Get file metadata
This operation gets file metadata using the file id.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| id | True | string | Specify the file id |
Returns
Blob metadata
- Body
- BlobMetadata
Get file metadata using path
This operation gets file metadata using the file path.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| path | True | string | Unique path of the file |
Returns
Blob metadata
- Body
- BlobMetadata
List files in folder
This operation gets files contained in a folder.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| id | True | string | Specify the folder |
Returns
- response
- array of BlobMetadata
List files in root folder
This operation gets the files in the root folder.
Returns
Rename File
This operation renames a file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| id | True | string | Select a file | |
New name | newName | True | string | New name for the file |
| ReadFileMetadataFromServer | boolean | Get all file metadata from the SFTP server after file creation is complete. If this is false, some metadata properties may not be returned such as last modified time, etc. |
Returns
Represents blob datasets metadata response
- Body
- BlobMetadataResponse
Update file
This operation updates the file content.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| id | True | string | Specify the file | |
File content | body | True | binary | Content of the file to update |
| ReadFileMetadataFromServer | boolean | Get all file metadata from the SFTP server after file creation is complete. If this is false, some metadata properties may not be returned such as last modified time, etc. |
Returns
Blob metadata
- Body
- BlobMetadata
Triggers
| When a file is added or modified | This operation triggers a flow when a file is added or modified in a folder. The trigger will fetch both the file metadata as well as the content of the file. The trigger relies on the last modified time of a file. If a file is being created by a third-party client, the preservation of the last modified time should be disabled in the client. Files larger than 50 megabytes are skipped by the trigger. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created. |
| When files are added or modified (properties only) | This operation triggers a flow when a file is added or modified in a folder. This trigger will only fetch the file metadata. To get the file content, you can use the 'Get file content' operation. The trigger relies on the last modified time of a file. If a file is being created by a third-party client, the preservation of the last modified time should be disabled in the client. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created. |
When a file is added or modified
This operation triggers a flow when a file is added or modified in a folder. The trigger will fetch both the file metadata as well as the content of the file. The trigger relies on the last modified time of a file. If a file is being created by a third-party client, the preservation of the last modified time should be disabled in the client. Files larger than 50 megabytes are skipped by the trigger. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| folderId | True | string | Specify a folder | |
Include file content | includeFileContent | boolean | If set to true, file content will also be retrieved along with the trigger response | |
| inferContentType | boolean | Infer content-type based on extension |
Returns
The content of the file.
Ssh And Sftp Client For Linux
- File Content
- binary
When files are added or modified (properties only)
This operation triggers a flow when a file is added or modified in a folder. This trigger will only fetch the file metadata. To get the file content, you can use the 'Get file content' operation. The trigger relies on the last modified time of a file. If a file is being created by a third-party client, the preservation of the last modified time should be disabled in the client. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
| folderId | True | string | Select a folder | |
Number of files | maxFileCount | integer | Number of files returned from the trigger (1-100) |
Returns
Blob metadata
Definitions
BlobMetadata
Blob metadata
| Name | Path | Type | Description |
|---|---|---|---|
| Id | string | The unique id of the file or folder. | |
Name | Name | string | The name of the file or folder. |
| DisplayName | string | The display name of the file or folder. | |
Path | Path | string | The path of the file or folder. |
| LastModified | date-time | The date and time the file or folder was last modified. | |
Size | Size | integer | The size of the file or folder. |
| MediaType | string | The media type of the file or folder. | |
IsFolder | IsFolder | boolean | A boolean value (true, false) to indicate whether or not the blob is a folder. |
| ETag | string | The etag of the file or folder. | |
FileLocator | FileLocator | string | The filelocator of the file or folder. |
BlobMetadataResponse
Represents blob datasets metadata response
| Name | Path | Type | Description |
|---|---|---|---|
| Id | string | The unique id of the file or folder. | |
Name | Name | string | The name of the file or folder. |
| DisplayName | string | The display name of the file or folder. | |
Path | Path | string | The path of the file or folder. |
| LastModified | date-time | The date and time the file or folder was last modified. | |
Size | Size | integer | The size of the file or folder. |
| MediaType | string | The media type of the file or folder. | |
IsFolder | IsFolder | boolean | A boolean value (true, false) to indicate whether or not the blob is a folder. |
| ETag | string | The etag of the file or folder. | |
FileLocator | FileLocator | string | The filelocator of the file or folder. |
binary
Ssh And Sftp Port Number
SSH key pairs allow an additional level of security that can be used in conjunction with the SFTP protocol.
Key pairs are typically created by the client, and then the resulting public key is used by Core FTP Server.
Core FTP products use the OpenSSH SSH2 format, that can be generated using Core FTP software, or via the ssh-keygen utility.
Core FTP client -- creating a key pair
Step 1: Advanced site settings -> ssh
Step 2: Entering key information
Step 3: Selecting private key into client site profile
Additionally if no account password is being used for the server, check the Advanced -> General -> 'Don't prompt for password when empty' option.
Ssh And Sftp Client For Mac
ssh-keygen usage: (Unix/Linux)
rsa keys: ssh-keygen -t
dsa keys: ssh-keygen -t dsa
For Unix/Linux, dsa keys may be the preferred method due to better compatibility across operating systems.
Putty users using psftp need to export OpenSSH public keys using Puttygen
Entering public key into Core FTP Server
Once you have created a key pair, the public key file is then placed in a directory on the server that cannot be accessed by the client account.
Select the public key file in the Core FTP Server's user 'security properties', in the 'ssh pub cert' field.
The server will need the 'Allow key authentication' option checked in the domain setup.
For SSH key pairs and no account password, the 'Key authentication only' option should be checked. Users not using keypairs can bypass the public key requirementby selecting the 'User does not require key authentication' in the user's 'security' settings.
A SSH key pair can be created on the server side from the above screen, but it is not recommended due to the security issues involved in sending the private key and it's password to the client. A public key being passed from a client to the server (administrator) is a much better option from a security standpoint.
Example of a public key (file contents):AAAAB3NzaC1yc2EAAAABIwAAAIEA153PICRN2+viqQ2570jEfUPcWgknD079wX/QtdF0lIbMaOYeMba9jf/qqmfuWYSybNmpSxMZiyjbKDvH+iZ/iT0MwrK9x19Zkjb8nXugWtOOJSwiHc48DSwMkLDdbVdG/BvstHbBquBdQNkJz+VDxFO+P3TcfYbIsvx+YFxnbLU=
or
ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAIEA153PICRN2+viqQ2570jEfUPcWgknD079wX/QtdF0lIbMaOYeMba9jf/qqmfuWYSybNmpSxMZiyjbKDvH+iZ/iT0MwrK9x19Zkjb8nXugWtOOJSwiHc48DSwMkLDdbVdG/BvstHbBquBdQNkJz+VDxFO+P3TcfYbIsvx+YFxnbLU=
The '=' character should be the last character in the public key. Multiple keys can be in one file, one per line. Begining characters identifying the key type at the beginning (rsa or dsa) are acceptable and read by Core FTP Server.
Keys should be in multibyte format.
Core FTP software utilizes SSH2 and greater versions of SSH...SSH1 is not supported
Core FTP Server Build 405 and greater supports RFC 4716 SSH formatted keys
ssh keys
What Is Sftp