Skip to main content
POST
Test Sftp Connection

Authorizations

X-API-Key
string
header
required

API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY

Example:

Authorization
string
header
required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Body

application/json

Request model for testing SFTP connection.

auth_type
enum<string>
required

Authentication type: password or key_file

Available options:
api_key,
oauth2,
user_password,
key_file,
client_credentials,
sharepoint_receive,
google_drive_receive
host
string
required

SFTP server hostname or IP address

username
string
required

Username for SFTP authentication

password
string | null

Password for SFTP authentication (required for password auth)

port
integer
default:22

SFTP server port

private_key_data
string | null

Private key content for SFTP authentication (required for key_file auth)

private_key_passphrase
string | null

Passphrase for encrypted private key (optional)

test_path
string
default:/

Directory path to test write access

Response

Successful Response