Skip to main content
POST
/
clients
Create client
curl --request POST \
  --url https://api.sftpsync.io/clients \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "Acme"
}'
{
  "id": "cl_123",
  "name": "Acme"
}

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required
sftpUsername
string
sftpPassword
string
sftpPrivateKey
string
sftpPassphrase
string
useHostedSFTP
boolean
awsUserName
string
awsPublicKey
string
awsPassword
string
ipWhitelist
string[]
sftpServerDataId
string

Response

200 - application/json

Client

id
string
required
name
string
required
workspaceId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
sftpUsername
string
sftpPassword
string
sftpPrivateKey
string
sftpPassphrase
string
useHostedSFTP
boolean
awsUserName
string
awsPublicKey
string
awsPassword
string
ipWhitelist
string[]
sftpServerDataId
string