This endpoint enables uploading and downloading package files.

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

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

Issue a token for a file upload

POST /api/users/{user_id}/packages/{package_id}/issue_token

This method returns the token required for uploading to an existing Faspex package. See Transferring a Package, step 4 for usage information.

Query Parameters: None

Request Body Parameters

Parameter Name Format Description
user_id string ID of user posting a file
package_id string Unique identifier for package
issue_token string Assigned token used to access the package
upload_destination string Directory path for the upload

Request Body

{“destination”: “{upload_destination}”}

Success Response Code

200 OK - Returns a response object

Response Body

{
"destination_root":
"package_outer_directory/package_inner_directory/upload_destination",
 "token": "token"
}
Video player

Video

×