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

https://bizdatapi-sb.bizdata360.com/token

Add request description…

Bodyform-data

username

password

POSTWrite Files (with username and password)

https://bizdatapi-sb.bizdata360.com/SFTPWrite

Add request description…

AuthorizationOAuth 2.0

Request Headers

Content-Type

application/json

Authorization

Bearer {{token}}

Bodyraw (json)

json

{
"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)

https://bizdatapi-sb.bizdata360.com/SFTPWrite

Add request description…

AuthorizationOAuth 2.0

Request Headers

Content-Type

application/json

Authorization

Bearer {{token}}

Bodyraw (json)

json

{
"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)

https://bizdatapi-sb.bizdata360.com/SFTPRead

Add request description…

AuthorizationOAuth 2.0

Request Headers

Content-Type

application/json

Authorization

Bearer {{token}}

Bodyraw (json)

json

{
"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)

https://bizdatapi-sb.bizdata360.com/SFTPRead

Add request description…

AuthorizationOAuth 2.0

Request Headers

Content-Type

application/json

Authorization

Bearer {{token}}

Bodyraw (json)

json

{
"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)

https://bizdatapi-sb.bizdata360.com/SFTPDelete

Add request description…

AuthorizationOAuth 2.0

Request Headers

Content-Type

application/json

Authorization

Bearer {{token}}

Bodyraw (json)

json

{
"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)

https://bizdatapi-sb.bizdata360.com/SFTPDelete

Add request description…

AuthorizationOAuth 2.0

Request Headers

Content-Type

application/json

Authorization

Bearer {{token}}

Bodyraw (json)

json

{
"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)

https://bizdatapi-sb.bizdata360.com/SFTPRead/Files

Add request description…

AuthorizationOAuth 2.0

Request Headers

Content-Type

application/json

Authorization

Bearer {{token}}

Bodyraw (json)

json

{
"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)

https://bizdatapi-sb.bizdata360.com/SFTPRead/Files

Add request description…

AuthorizationOAuth 2.0

Request Headers

Content-Type

application/json

Authorization

Bearer {{token}}

Bodyraw (json)

json

{
"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}}"
}