Skip to main content
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"
}
'
{
  "uploadId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "initiated",
  "totalParts": 3,
  "filename": "employees.json"
}

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

Body

application/json
​
pipelineName
string
required

Name of the outbound pipeline (must have direction: "outbound").

​
totalParts
integer
required

Total number of parts to upload.

Required range: x >= 1
​
connectionName
string

The connection's human-readable name. Resolves identically for hosted and self-hosted SFTP.

​
clientName
string
deprecated

Deprecated: use connectionName. Resolved by the connection's name.

​
filename
string

Optional final filename. Defaults to upload-{uploadId}.json.

​
outputFilename
string

Exact name for the delivered file. Extension appended from outputFormat if omitted.

​
outputFormat
enum<string>

Output serialization. Overrides format; inferred from outputFilename extension if omitted, else defaults to JSON.

Available options:
csv,
json,
xml

Response

Upload session created

​
uploadId
string
required
​
status
enum<string>
required
Available options:
initiated,
uploading,
completed,
aborted
​
totalParts
integer
required
​
filename
string
required