Update connection
curl --request PATCH \
--url https://api.sftpsync.io/connections/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"type": "SFTP",
"sftpUsername": "<string>",
"sftpPassword": "<string>",
"sftpPrivateKey": "<string>",
"sftpPassphrase": "<string>",
"useHostedSFTP": true,
"awsUserName": "<string>",
"awsPublicKey": "<string>",
"awsPassword": "<string>",
"ipWhitelist": [
"<string>"
],
"sftpServerDataId": "<string>",
"sftpHost": "<string>",
"sftpPort": 123,
"sftpRemotePath": "<string>",
"emailAllowedSenders": [
"<string>"
],
"emailAllowedFormats": [],
"emailSubjectFilter": "<string>",
"emailInboundAddress": "jsmith@example.com"
}
'import requests
url = "https://api.sftpsync.io/connections/{id}"
payload = {
"name": "<string>",
"type": "SFTP",
"sftpUsername": "<string>",
"sftpPassword": "<string>",
"sftpPrivateKey": "<string>",
"sftpPassphrase": "<string>",
"useHostedSFTP": True,
"awsUserName": "<string>",
"awsPublicKey": "<string>",
"awsPassword": "<string>",
"ipWhitelist": ["<string>"],
"sftpServerDataId": "<string>",
"sftpHost": "<string>",
"sftpPort": 123,
"sftpRemotePath": "<string>",
"emailAllowedSenders": ["<string>"],
"emailAllowedFormats": [],
"emailSubjectFilter": "<string>",
"emailInboundAddress": "jsmith@example.com"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
type: 'SFTP',
sftpUsername: '<string>',
sftpPassword: '<string>',
sftpPrivateKey: '<string>',
sftpPassphrase: '<string>',
useHostedSFTP: true,
awsUserName: '<string>',
awsPublicKey: '<string>',
awsPassword: '<string>',
ipWhitelist: ['<string>'],
sftpServerDataId: '<string>',
sftpHost: '<string>',
sftpPort: 123,
sftpRemotePath: '<string>',
emailAllowedSenders: ['<string>'],
emailAllowedFormats: [],
emailSubjectFilter: '<string>',
emailInboundAddress: 'jsmith@example.com'
})
};
fetch('https://api.sftpsync.io/connections/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sftpsync.io/connections/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'type' => 'SFTP',
'sftpUsername' => '<string>',
'sftpPassword' => '<string>',
'sftpPrivateKey' => '<string>',
'sftpPassphrase' => '<string>',
'useHostedSFTP' => true,
'awsUserName' => '<string>',
'awsPublicKey' => '<string>',
'awsPassword' => '<string>',
'ipWhitelist' => [
'<string>'
],
'sftpServerDataId' => '<string>',
'sftpHost' => '<string>',
'sftpPort' => 123,
'sftpRemotePath' => '<string>',
'emailAllowedSenders' => [
'<string>'
],
'emailAllowedFormats' => [
],
'emailSubjectFilter' => '<string>',
'emailInboundAddress' => 'jsmith@example.com'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sftpsync.io/connections/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"SFTP\",\n \"sftpUsername\": \"<string>\",\n \"sftpPassword\": \"<string>\",\n \"sftpPrivateKey\": \"<string>\",\n \"sftpPassphrase\": \"<string>\",\n \"useHostedSFTP\": true,\n \"awsUserName\": \"<string>\",\n \"awsPublicKey\": \"<string>\",\n \"awsPassword\": \"<string>\",\n \"ipWhitelist\": [\n \"<string>\"\n ],\n \"sftpServerDataId\": \"<string>\",\n \"sftpHost\": \"<string>\",\n \"sftpPort\": 123,\n \"sftpRemotePath\": \"<string>\",\n \"emailAllowedSenders\": [\n \"<string>\"\n ],\n \"emailAllowedFormats\": [],\n \"emailSubjectFilter\": \"<string>\",\n \"emailInboundAddress\": \"jsmith@example.com\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.sftpsync.io/connections/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"SFTP\",\n \"sftpUsername\": \"<string>\",\n \"sftpPassword\": \"<string>\",\n \"sftpPrivateKey\": \"<string>\",\n \"sftpPassphrase\": \"<string>\",\n \"useHostedSFTP\": true,\n \"awsUserName\": \"<string>\",\n \"awsPublicKey\": \"<string>\",\n \"awsPassword\": \"<string>\",\n \"ipWhitelist\": [\n \"<string>\"\n ],\n \"sftpServerDataId\": \"<string>\",\n \"sftpHost\": \"<string>\",\n \"sftpPort\": 123,\n \"sftpRemotePath\": \"<string>\",\n \"emailAllowedSenders\": [\n \"<string>\"\n ],\n \"emailAllowedFormats\": [],\n \"emailSubjectFilter\": \"<string>\",\n \"emailInboundAddress\": \"jsmith@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sftpsync.io/connections/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"type\": \"SFTP\",\n \"sftpUsername\": \"<string>\",\n \"sftpPassword\": \"<string>\",\n \"sftpPrivateKey\": \"<string>\",\n \"sftpPassphrase\": \"<string>\",\n \"useHostedSFTP\": true,\n \"awsUserName\": \"<string>\",\n \"awsPublicKey\": \"<string>\",\n \"awsPassword\": \"<string>\",\n \"ipWhitelist\": [\n \"<string>\"\n ],\n \"sftpServerDataId\": \"<string>\",\n \"sftpHost\": \"<string>\",\n \"sftpPort\": 123,\n \"sftpRemotePath\": \"<string>\",\n \"emailAllowedSenders\": [\n \"<string>\"\n ],\n \"emailAllowedFormats\": [],\n \"emailSubjectFilter\": \"<string>\",\n \"emailInboundAddress\": \"jsmith@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"type": "SFTP",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"sftpUsername": "<string>",
"useHostedSFTP": true,
"awsUserName": "<string>",
"awsPublicKey": "<string>",
"ipWhitelist": [
"<string>"
],
"sftpServerDataId": "<string>",
"sftpServer": {
"id": "<string>",
"name": "<string>",
"isAwsHosted": true,
"host": "<string>",
"port": 123,
"status": "<string>",
"rootDirectory": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"emailInbox": {
"inboundAddress": "<string>",
"allowedSenders": [
"<string>"
],
"allowedFormats": [
"csv"
],
"subjectFilter": "<string>"
}
}Connections
Update connection
PATCH
/
connections
/
{id}
Update connection
curl --request PATCH \
--url https://api.sftpsync.io/connections/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"type": "SFTP",
"sftpUsername": "<string>",
"sftpPassword": "<string>",
"sftpPrivateKey": "<string>",
"sftpPassphrase": "<string>",
"useHostedSFTP": true,
"awsUserName": "<string>",
"awsPublicKey": "<string>",
"awsPassword": "<string>",
"ipWhitelist": [
"<string>"
],
"sftpServerDataId": "<string>",
"sftpHost": "<string>",
"sftpPort": 123,
"sftpRemotePath": "<string>",
"emailAllowedSenders": [
"<string>"
],
"emailAllowedFormats": [],
"emailSubjectFilter": "<string>",
"emailInboundAddress": "jsmith@example.com"
}
'import requests
url = "https://api.sftpsync.io/connections/{id}"
payload = {
"name": "<string>",
"type": "SFTP",
"sftpUsername": "<string>",
"sftpPassword": "<string>",
"sftpPrivateKey": "<string>",
"sftpPassphrase": "<string>",
"useHostedSFTP": True,
"awsUserName": "<string>",
"awsPublicKey": "<string>",
"awsPassword": "<string>",
"ipWhitelist": ["<string>"],
"sftpServerDataId": "<string>",
"sftpHost": "<string>",
"sftpPort": 123,
"sftpRemotePath": "<string>",
"emailAllowedSenders": ["<string>"],
"emailAllowedFormats": [],
"emailSubjectFilter": "<string>",
"emailInboundAddress": "jsmith@example.com"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
type: 'SFTP',
sftpUsername: '<string>',
sftpPassword: '<string>',
sftpPrivateKey: '<string>',
sftpPassphrase: '<string>',
useHostedSFTP: true,
awsUserName: '<string>',
awsPublicKey: '<string>',
awsPassword: '<string>',
ipWhitelist: ['<string>'],
sftpServerDataId: '<string>',
sftpHost: '<string>',
sftpPort: 123,
sftpRemotePath: '<string>',
emailAllowedSenders: ['<string>'],
emailAllowedFormats: [],
emailSubjectFilter: '<string>',
emailInboundAddress: 'jsmith@example.com'
})
};
fetch('https://api.sftpsync.io/connections/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sftpsync.io/connections/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'type' => 'SFTP',
'sftpUsername' => '<string>',
'sftpPassword' => '<string>',
'sftpPrivateKey' => '<string>',
'sftpPassphrase' => '<string>',
'useHostedSFTP' => true,
'awsUserName' => '<string>',
'awsPublicKey' => '<string>',
'awsPassword' => '<string>',
'ipWhitelist' => [
'<string>'
],
'sftpServerDataId' => '<string>',
'sftpHost' => '<string>',
'sftpPort' => 123,
'sftpRemotePath' => '<string>',
'emailAllowedSenders' => [
'<string>'
],
'emailAllowedFormats' => [
],
'emailSubjectFilter' => '<string>',
'emailInboundAddress' => 'jsmith@example.com'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sftpsync.io/connections/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"SFTP\",\n \"sftpUsername\": \"<string>\",\n \"sftpPassword\": \"<string>\",\n \"sftpPrivateKey\": \"<string>\",\n \"sftpPassphrase\": \"<string>\",\n \"useHostedSFTP\": true,\n \"awsUserName\": \"<string>\",\n \"awsPublicKey\": \"<string>\",\n \"awsPassword\": \"<string>\",\n \"ipWhitelist\": [\n \"<string>\"\n ],\n \"sftpServerDataId\": \"<string>\",\n \"sftpHost\": \"<string>\",\n \"sftpPort\": 123,\n \"sftpRemotePath\": \"<string>\",\n \"emailAllowedSenders\": [\n \"<string>\"\n ],\n \"emailAllowedFormats\": [],\n \"emailSubjectFilter\": \"<string>\",\n \"emailInboundAddress\": \"jsmith@example.com\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.sftpsync.io/connections/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"SFTP\",\n \"sftpUsername\": \"<string>\",\n \"sftpPassword\": \"<string>\",\n \"sftpPrivateKey\": \"<string>\",\n \"sftpPassphrase\": \"<string>\",\n \"useHostedSFTP\": true,\n \"awsUserName\": \"<string>\",\n \"awsPublicKey\": \"<string>\",\n \"awsPassword\": \"<string>\",\n \"ipWhitelist\": [\n \"<string>\"\n ],\n \"sftpServerDataId\": \"<string>\",\n \"sftpHost\": \"<string>\",\n \"sftpPort\": 123,\n \"sftpRemotePath\": \"<string>\",\n \"emailAllowedSenders\": [\n \"<string>\"\n ],\n \"emailAllowedFormats\": [],\n \"emailSubjectFilter\": \"<string>\",\n \"emailInboundAddress\": \"jsmith@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sftpsync.io/connections/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"type\": \"SFTP\",\n \"sftpUsername\": \"<string>\",\n \"sftpPassword\": \"<string>\",\n \"sftpPrivateKey\": \"<string>\",\n \"sftpPassphrase\": \"<string>\",\n \"useHostedSFTP\": true,\n \"awsUserName\": \"<string>\",\n \"awsPublicKey\": \"<string>\",\n \"awsPassword\": \"<string>\",\n \"ipWhitelist\": [\n \"<string>\"\n ],\n \"sftpServerDataId\": \"<string>\",\n \"sftpHost\": \"<string>\",\n \"sftpPort\": 123,\n \"sftpRemotePath\": \"<string>\",\n \"emailAllowedSenders\": [\n \"<string>\"\n ],\n \"emailAllowedFormats\": [],\n \"emailSubjectFilter\": \"<string>\",\n \"emailInboundAddress\": \"jsmith@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"type": "SFTP",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"sftpUsername": "<string>",
"useHostedSFTP": true,
"awsUserName": "<string>",
"awsPublicKey": "<string>",
"ipWhitelist": [
"<string>"
],
"sftpServerDataId": "<string>",
"sftpServer": {
"id": "<string>",
"name": "<string>",
"isAwsHosted": true,
"host": "<string>",
"port": 123,
"status": "<string>",
"rootDirectory": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"emailInbox": {
"inboundAddress": "<string>",
"allowedSenders": [
"<string>"
],
"allowedFormats": [
"csv"
],
"subjectFilter": "<string>"
}
}Authorizations
Path Parameters
Body
application/json
Connection kind. Defaults to SFTP. Set to EMAIL to create an email inbox connection — the email* fields then apply and SFTP fields are ignored.
Available options:
SFTP, EMAIL Self-hosted SFTP (useHostedSFTP=false): the customer SFTP host FileFeed dials out to.
Self-hosted SFTP port.
Self-hosted SFTP remote directory.
EMAIL only. Allowed senders — full address (alice@acme.com) or root-domain pattern (@acme.com). Empty/omitted = accept any sender.
Maximum array length:
50EMAIL only. Attachment accept-list. Required and non-empty for EMAIL connections.
Minimum array length:
1Available options:
csv, xlsx, xls, json, xml, tsv EMAIL only. Case-insensitive substring required in the subject. Empty = no filter.
Maximum string length:
200EMAIL only, create-only and immutable. Custom inbound address {workspace-slug}.{connection-slug}@in.filefeed.io. Omit to have one generated (feed-XXXX@in.filefeed.io).
Maximum string length:
320Response
200 - application/json
Connection
An SFTP / Email / API endpoint with its credentials. Canonical name as of API version 2026-05-25 (formerly Client). Credentials (sftpPassword / sftpPrivateKey / sftpPassphrase / awsPassword) are write-only and never returned in responses.
Connection kind. Always present as of API version 2026-05-25.
Available options:
SFTP, EMAIL Server-generated SFTP username slug for a FileFeed-hosted connection. (Outbound uploads reference a connection by its human-readable name, not this slug.)
The SFTP server a connection is bound to. For a self-hosted connection, host/port/rootDirectory describe the customer endpoint FileFeed dials out to; for a hosted connection, the FileFeed-managed AWS Transfer server.
Show child attributes
Show child attributes
Resolved inbox config for an EMAIL connection. Returned on Connection.emailInbox, present only when type = EMAIL.
Show child attributes
Show child attributes