Skip to main content
PATCH
/
clients
/
{id}
Update client
curl --request PATCH \
  --url https://api.sftpsync.io/clients/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "sftpUsername": "<string>",
  "sftpPassword": "<string>",
  "sftpPrivateKey": "<string>",
  "sftpPassphrase": "<string>",
  "useHostedSFTP": true,
  "awsUserName": "<string>",
  "awsPublicKey": "<string>",
  "awsPassword": "<string>",
  "ipWhitelist": [
    "<string>"
  ],
  "sftpServerDataId": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "workspaceId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "sftpUsername": "<string>",
  "sftpPassword": "<string>",
  "sftpPrivateKey": "<string>",
  "sftpPassphrase": "<string>",
  "useHostedSFTP": true,
  "awsUserName": "<string>",
  "awsPublicKey": "<string>",
  "awsPassword": "<string>",
  "ipWhitelist": [
    "<string>"
  ],
  "sftpServerDataId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.filefeed.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Body

application/json

Deprecated — alias for UpdateConnectionParams.

​
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

Deprecated — alias for Connection. Removed when API version 2024-09-01 sunsets on 2027-05-25.

​
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