Skip to content
File Service

Fs Upload

An upload is a temporary entity created for the purpose of uploading a file. This entity is established by providing the file name, parent folder ID, and other metadata. Since file uploading is an asynchronous process, an upload job is created, and the job identifier can be used to track the status of the file upload. The response will also include an upload URL, which is valid for 1 hour by default but can be extended up to 7 days. This URL is used to upload the file’s content. Retrieving the upload entity again will regenerate a fresh upload URL with a new expiration.

Uploads persist for 30 days after their creation, after which they will no longer be accessible whether they have been uploaded to or not.

Additional information about the file can be added as custom metadata during creation. Any valid JSON-formatted key-value pairs are accepted, with a maximum size limit of 64KB.

Upload Type

File service supports two different file types:

  • SINGLE-PART: A mechanism to upload a single file directly to the file service system, with a maximum uploadable content size of 5GB.
  • MULTI-PART: A mechanism to upload large files in smaller parts. After all parts are uploaded, a complete multipart upload request merges them into a single file. Each part must be between 5MB and 5GB, except the final part, which can be smaller than 5MB. The total number of parts is capped at 10,000. The multipart upload request may return an ETag value, which the client must include with the corresponding part identifier in the multipart upload completion request. Note that the ETag value is not validated for “azure” cloud provider in the multipart completion request.

Package Upload

Package upload allows for the simultaneous uploading of a main file along with its associated support files. In this process, unique upload URLs are generated for both the main file and each support file, which are uploaded individually to their respective URLs. By default, the support files are automatically linked to the main file.

The key difference between a normal upload and a package upload is that, in a normal upload, support files are uploaded individually and linked to an existing main file, with an option to link or not link them to the main file. In contrast, a package upload includes support files as part of a package with the main file, where they are always linked. Package uploads are transactional. If any individual file in the package fails to upload, the other files in the package will also fail.

To get more information on the Support file click here