Skip to main content

SFTP API


With SFTP APIs, we can utilize programming interfaces to establish connections to any server and perform file operations securely. These APIs enable developers to read, write, and delete files present on the server, making it possible to automate and streamline file transfer processes while ensuring data security through the use of the Secure File Transfer Protocol (SFTP).

POSTToken

{{base_url}}/token

Add request description…

Bodyform-data
username
{{Username}}
password
{{Password}}

POSTWrite Files (with username and password)

{{base_url}}/SFTPWrite

Add request description…

AuthorizationOAuth 2.0

Request Headers
Content-Type
application/json
Authorization
Bearer {{token}}
Bodyraw (json)
Note: The default port number is 22, users can set the port number based on the server they want to connect. 

{
"hostname":"{{host_name}}",
"username":"{{user_name}}",
"auth_type":"password",
"password":"{{password}}",
"port":22,
"pem_key":"",
"dataset":"{{file_content}}",
"file_to_path":"{{file_path}}",
"mode":"w",
"passphrase":"{{pass_phrase}}"
}

POSTWrite Files (with username and pem-key)

{{base_url}}/SFTPWrite

Add request description…

AuthorizationOAuth 2.0

Request Headers
Content-Type
application/json
Authorization
Bearer {{token}}
Bodyraw (json)
Note: The default port number is 22, users can set the port number based on the server they want to connect.
{
"hostname":"{{host_name}}",
"username":"{{user_name}}",
"auth_type":"pem_key",
"password":"",
"port":22,
"pem_key":"{{pem_key}}",
"dataset":"{{file_content}}",
"file_to_path":"{{file_location}}",
"mode":"w",
"passphrase":"{{pass_phrase}}"
}

POSTRead Files (with username and password)

{{base_url}}/SFTPRead

Add request description…

AuthorizationOAuth 2.0

Request Headers
Content-Type
application/json
Authorization
Bearer {{token}}
Bodyraw (json)
Note: The default port number is 22, users can set the port number based on the server they want to connect.

{
"hostname":"{{host_name}}",
"username":"{{user_name}}",
"auth_type":"password",
"password":"{{password}}",
"port":22,
"pem_key":"",
"file_to_path":"{{file_path}}",
"mode":"r",
"passphrase":"{{pass_phrase}}"
}

POSTRead Files (with username and pem-key)

{{base_url}}/SFTPRead

Add request description…

AuthorizationOAuth 2.0

Request Headers
Content-Type
application/json
Authorization
Bearer {{token}}
Bodyraw (json)
Note: The default port number is 22, users can set the port number based on the server they want to connect.

{
"hostname":"{{host_name}}",
"username":"{{user_name}}",
"auth_type":"pem_key",
"password":"",
"port":22,
"pem_key":"{{pem_key}}",
"file_to_path":"{{file_path}}",
"mode":"r",
"passphrase":"{{pass_phrase}}"
}

POSTDelete Files (with username and password)

{{base_url}}/SFTPDelete

Add request description…

AuthorizationOAuth 2.0

Request Headers
Content-Type
application/json
Authorization
Bearer {{token}}
Bodyraw (json)
Note: The default port number is 22, users can set the port number based on the server they want to connect.

{
"hostname":"{{host_name}}",
"username":"{{user_name}}",
"auth_type":"password",
"password":"{{password}}",
"port":22,
"pem_key":"",
"file_to_path":"{{file_path}}",
"passphrase":"{{pass_phrase}}"
}

POSTDelete Files (with username and pem-key)

{{base_url}}/SFTPDelete

Add request description…

AuthorizationOAuth 2.0

Request Headers
Content-Type
application/json
Authorization
Bearer {{token}}
Bodyraw (json)
Note: The default port number is 22, users can set the port number based on the server they want to connect.

{
"hostname":"{{host_name}}",
"username":"{{user_name}}",
"auth_type":"pem_key",
"password":"",
"port":22,
"pem_key":"{{pem_key}}",
"file_to_path":"{{file_path}}",
"passphrase":"{{pass_phrase}}"
}

POSTRead Folder (with username and password)

{{base_url}}/SFTPRead/Files

Add request description…

AuthorizationOAuth 2.0

Request Headers
Content-Type
application/json
Authorization
Bearer {{token}}
Bodyraw (json)
Note: The default port number is 22, users can set the port number based on the server they want to connect.

{
"hostname":"{{host_name}}",
"username":"{{user_name}}",
"auth_type":"password",
"password":"{{password}}",
"port":22,
"pem_key":"",
"file_to_path":"{{file_path}}",
"passphrase":"{{passphrase}}"
}

POSTRead Folder (with username and pem-key)

{{base_url}}/SFTPRead/Files

Add request description…

AuthorizationOAuth 2.0

Request Headers
Content-Type
application/json
Authorization
Bearer {{token}}
Bodyraw (json)
Note: The default port number is 22, users can set the port number based on the server they want to connect.

{
"hostname":"{{host_name}}",
"username":"{{user_name}}",
"auth_type":"pem_key",
"password":"",
"port":22,
"pem_key":"{{pem_key}}",
"file_to_path":"{{file_path}}",
"passphrase":"{{pass_phrase}}"
}

To try out the provided API endpoints on our eZintegrations app, please follow the steps below:

  1. Visit our website: www.eZintegrations.com.
  2. Click on the "Try it here" to create a new user account.
  3. Fill in the required information to complete the signup process.
  4. Once registered, log in to your account using your credentials.
  5. Navigate to the API Marketplace section on our website.
  6. In the API Marketplace, you will find the SFTP API.
  7. Take a look at the available endpoints and you can try it out.

For Username and Password or Pem-key and other queries related to SFTP API, please reach out to our support team at:    

Email:  mailto:support@bizdata360.com

Back to top