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 '
{
  "clientName": "acme-corp",
  "pipelineName": "employee-sync",
  "totalParts": 3,
  "filename": "employees.json"
}
'
{
  "uploadId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "initiated",
  "totalParts": 3,
  "filename": "employees.json"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
clientName
string
required

Client name (awsUserName of the client).

​
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
​
filename
string

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

Response

Upload session created

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