This endpoint returns information about transfers and initiates transfers.

Note: Any endpoint that begins with "/api/users/" (unless it's in the form "/api/users/me/") is accessible to admins only. The identifier me—indicating that the user is accessing data within their own domain of privileges, only—can be substituted for {user_id} or {dropbox_id} in the request.

Common Error Codes:

  • 204 No Content - Package not found; returns an error object
  • 400 Bad Request - Request parameters are invalid; returns an error object
  • 500 HTTP Internal Server Error - Request is valid but the server encountered an error; returns an error object

Get package transfer history (for transfer sessions) for users or dropboxes

GET /api/users/{user_id}/packages/{package_delivery_id}/transfers
GET /api/dropboxes)/{dropbox_id}/packages/{package_delivery_id}/transfers

This method performs a query on the transfer sessions for a package.

Query Parameters:

Parameter Name Required/Optional Format Description
direction optional string Available values: send, receive

Response Codes:

  • 200 OK - returns an array of transfer progress objects

Initiate a remote content upload

POST /api/(users|dropboxes)/{user_id|dropbox_id}/packages/{package_delivery_id}/transfers

Query Parameters: None

Request Body Parameters

Parameter Name Required/Optional Format Description
direction required string The direction of the transfer. Allowed value: send
paths required array of strings The relative paths to the target upload directories
share_id required integer The ID of the source share
ear_passphrase required* (see Description field) string The passphrase for encryption at rest. *Required if the package has ear_enabled=true, optional if ear_enabled=false. Refer to the request parameters for the method, "Create a package".

Request Body Example:

{
			“direction”: “send”
			“paths” : [ “share/relative/path/to/file1”, … ],
			“share_id” : “sfiajfnsfnsdf”
			“ear_passphrase” : "“4kIalkasdfli9ID”
		}

Success Response:

  • 200 OK - returns transfer progress object in the response body
Video player

Video

×