Skip to main content
POST
/
connections
/
{id}
/
test-connection
Test SFTP connection
curl --request POST \
  --url https://api.sftpsync.io/connections/{id}/test-connection \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "message": "Connected"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Response

200 - application/json

Connection result

​
success
boolean
required
​
message
string
required