files.createUpload

API: Stable Auth: Users

Creates an upload session between the user and the provider

Request Response Error
BulkRequest<FilesCreateUploadRequestItem> BulkResponse<FilesCreateUploadResponseItem> CommonErrorMessage

An upload can be either a file or folder, if supported by the provider, and depending on the UploadTypespecified in the request. The desired path and a list of supported UploadProtocols are also specified in the request. The latter is used by the provider to negotiate which protocol to use.

The response will contain an endpoint which is ready to accept the upload, as well as the chosen UploadProtocol and a unique token.

At the time of writing the default and preferred protocol is UploadProtocol.WEBSOCKET.

Errors:

Status Code Description
404 Not Found Either the oldPath or newPath exists or you lack permissions
403 Forbidden You lack permissions to perform this operation

Examples:

Example
Uploading a file with the chunked protocol