Pull - Byteport

POST

pull

curl -X POST https://api.byteport.com/pull \
  -H "Authorization: Bearer bp_xxxxxxxxx" \
  -H "User-Agent: my-app/1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "https://example.com/report.pdf",
    "to":   "Production Bucket/reports/report.pdf"
  }'

{
  "id": "trf_01HZ...",
  "status": "queued"
}

Pulls from a link to a destination path. Byteport fetches the file server-side — you do not need to download it locally first.

Body parameters

from

string | string[]

required

URL to pull from.

string

required

Destination location path. Must be a valid location and file name.

Example

curl -X POST https://api.byteport.com/pull \
  -H "Authorization: Bearer bp_xxxxxxxxx" \
  -H "User-Agent: my-app/1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "https://example.com/report.pdf",
    "to":   "Production Bucket/reports/report.pdf"
  }'

{
  "id": "trf_01HZ...",
  "status": "queued"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

from

required

URL to pull from.

string

required

Destination location path. Must be a valid location and file name.

Response

Pull accepted

string

Identifier for the transfer.

status

enum<string>

Available options:

queued,

running,

complete

Move

Remove

curl -X POST https://api.byteport.com/pull \
  -H "Authorization: Bearer bp_xxxxxxxxx" \
  -H "User-Agent: my-app/1.0" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "https://example.com/report.pdf",
    "to":   "Production Bucket/reports/report.pdf"
  }'

{
  "id": "trf_01HZ...",
  "status": "queued"
}

​Body parameters

​Example

Authorizations

Body

Response

Body parameters

Example