Initialize an outbound multipart upload session
curl --request POST \
--url https://api.sftpsync.io/outbound/uploads \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"connectionName": "Acme Corp",
"pipelineName": "employee-sync",
"totalParts": 3,
"filename": "employees.json"
}
'import requests
url = "https://api.sftpsync.io/outbound/uploads"
payload = {
"connectionName": "Acme Corp",
"pipelineName": "employee-sync",
"totalParts": 3,
"filename": "employees.json"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connectionName: 'Acme Corp',
pipelineName: 'employee-sync',
totalParts: 3,
filename: 'employees.json'
})
};
fetch('https://api.sftpsync.io/outbound/uploads', 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/outbound/uploads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'connectionName' => 'Acme Corp',
'pipelineName' => 'employee-sync',
'totalParts' => 3,
'filename' => 'employees.json'
]),
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/outbound/uploads"
payload := strings.NewReader("{\n \"connectionName\": \"Acme Corp\",\n \"pipelineName\": \"employee-sync\",\n \"totalParts\": 3,\n \"filename\": \"employees.json\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.sftpsync.io/outbound/uploads")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connectionName\": \"Acme Corp\",\n \"pipelineName\": \"employee-sync\",\n \"totalParts\": 3,\n \"filename\": \"employees.json\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sftpsync.io/outbound/uploads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connectionName\": \"Acme Corp\",\n \"pipelineName\": \"employee-sync\",\n \"totalParts\": 3,\n \"filename\": \"employees.json\"\n}"
response = http.request(request)
puts response.read_body{
"uploadId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "initiated",
"totalParts": 3,
"filename": "employees.json"
}{
"message": "<string>",
"statusCode": 123,
"error": "<string>"
}{
"message": "<string>",
"statusCode": 123,
"error": "<string>"
}Outbound Uploads
Initialize an outbound multipart upload session
Creates a new upload session for pushing JSON data into an outbound pipeline. The pipeline must have direction: "outbound".
POST
/
outbound
/
uploads
Initialize an outbound multipart upload session
curl --request POST \
--url https://api.sftpsync.io/outbound/uploads \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"connectionName": "Acme Corp",
"pipelineName": "employee-sync",
"totalParts": 3,
"filename": "employees.json"
}
'import requests
url = "https://api.sftpsync.io/outbound/uploads"
payload = {
"connectionName": "Acme Corp",
"pipelineName": "employee-sync",
"totalParts": 3,
"filename": "employees.json"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connectionName: 'Acme Corp',
pipelineName: 'employee-sync',
totalParts: 3,
filename: 'employees.json'
})
};
fetch('https://api.sftpsync.io/outbound/uploads', 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/outbound/uploads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'connectionName' => 'Acme Corp',
'pipelineName' => 'employee-sync',
'totalParts' => 3,
'filename' => 'employees.json'
]),
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/outbound/uploads"
payload := strings.NewReader("{\n \"connectionName\": \"Acme Corp\",\n \"pipelineName\": \"employee-sync\",\n \"totalParts\": 3,\n \"filename\": \"employees.json\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.sftpsync.io/outbound/uploads")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connectionName\": \"Acme Corp\",\n \"pipelineName\": \"employee-sync\",\n \"totalParts\": 3,\n \"filename\": \"employees.json\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sftpsync.io/outbound/uploads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connectionName\": \"Acme Corp\",\n \"pipelineName\": \"employee-sync\",\n \"totalParts\": 3,\n \"filename\": \"employees.json\"\n}"
response = http.request(request)
puts response.read_body{
"uploadId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "initiated",
"totalParts": 3,
"filename": "employees.json"
}{
"message": "<string>",
"statusCode": 123,
"error": "<string>"
}{
"message": "<string>",
"statusCode": 123,
"error": "<string>"
}Authorizations
Body
application/json
Name of the outbound pipeline (must have direction: "outbound").
Total number of parts to upload.
Required range:
x >= 1The connection's human-readable name. Resolves identically for hosted and self-hosted SFTP.
Deprecated: use connectionName. Resolved by the connection's name.
Optional final filename. Defaults to upload-{uploadId}.json.
Exact name for the delivered file. Extension appended from outputFormat if omitted.
Output serialization. Overrides format; inferred from outputFilename extension if omitted, else defaults to JSON.
Available options:
csv, json, xml