Skip to main content
POST
/
api
/
transfers
/
cURL
curl --request POST \
  --url https://{server}/api/transfers/ \
  --header 'Content-Type: application/json' \
  --cookie sessionid= \
  --data '
{
  "content_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "files": [
    "<string>"
  ],
  "expires_in": 86400,
  "supported_protocols": [
    "<string>"
  ],
  "origin": "user"
}
'
{
  "transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "credentials": {},
  "endpoint": "<string>",
  "prefix": "<string>",
  "files": [
    {}
  ],
  "expires_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
sessionid
string
cookie
required

Body

​
content_id
string<uuid>
required
​
type
enum<string>
required
  • upload - upload
  • download - download
Available options:
upload,
download
​
files
string[]

Upload only: list of filenames to transfer.

​
expires_in
integer
default:86400

TTL in seconds (default 86400 = 1 day).

Required range: 60 <= x <= 604800
​
supported_protocols
string[]

Preferred transfer protocols, e.g. ['s3']. Accepted but not yet used in credential selection.

​
origin
enum<string>
default:user

Transfer source. 'system' is used for internal fetches (e.g. README auto-load) and is filtered out of the tracker list by default.

  • user - user
  • system - system
Available options:
user,
system

Response

201 - application/json
​
transfer_id
string<uuid>
required
​
credentials
object
required
​
endpoint
string
required
​
prefix
string
required
​
files
object[]
required
​
expires_at
string<date-time>
required