Report status or progress for one of the caller's transfers

Records the reported state. Reporting the in-progress state for the direction ("Downloading" for downloads, "Uploading" for uploads) is a progress update; reporting a final state ("Complete", "Error", "Cancelled") ends the transfer. Progress fields are only read while the transfer is in an in-progress state, and upload progress reports are ignored because the server counts bytes itself.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The transfer direction path segment: "uploads" or "downloads"

string
required

The unique identifier (UUID) of the transfer

string

The new transfer status: one of "Queued", "Downloading", "Uploading", "Error", "Complete", "Cancelled"

integer

Percent complete, 0 to 100. Only read for an in-progress status

integer

Bytes moved so far, when the client tracks it

string

The failure reason. Only read alongside the "Error" status

integer

The total size in bytes, when known to the client. Downloads only: lets the server derive a percentage from BYTES_TRANSFERRED. Set once; later values are ignored

Responses

400

Bad Request

401

The caller is not authenticated

404

No such transfer belongs to the caller

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json