Source Code Bundles
Prepares for uploading the parts of a large file.
Request HTTP Headers
An account authorization token, obtained from
Request HTTP Message Body Parameters
The ID of the bucket that the file will go in.
The name of the file. See Files for requirements on file names.
The MIME type of the content of the file, which will
be returned in the
A JSON object holding the name/value pairs for the custom file info.
If the original source of the file being uploaded has a last modified
time concept, Backblaze recommends using
If the caller knows the SHA1 of the entire large file being uploaded,
Backblaze recommends using
To set the Content-Disposition header provided when the file is downloaded, set 'b2-content-disposition'. (It may be overridden by a value given in the download request.) The value must match the grammar specified in RFC 6266. Parameter continuations are not supported. 'Extended-value's are supported for charset 'UTF-8' (case-insensitive) when the language is empty. Note that this file info will not be included in downloads as a x-bz-info-b2-content-disposition header. Instead, it (or the value specified in a request) will be in the Content-Disposition.
The file name and file info must fit, along with the other necessary headers, within a 7,000 byte limit. This ensures that when the file is downloaded that all of the information can be included in the headers.
Response HTTP Status 200
The account that owns the file.
One of "start", "upload", "hide", "folder", or other values added
in the future.
"upload" means a file that was uploaded to B2 Cloud Storage.
"start" means that a large file has been started, but not
finished or canceled.
"hide" means a file version marking the file as hidden, so that it will not
show up in
The bucket that the file is in.
The number of bytes stored in the file. Only useful when the action is "upload". Always 0 when the action is "start", "hide", or "folder".
The SHA1 of the bytes stored in the file as a 40-digit hex string. Large files do not have SHA1 checksums, and the value is "none". The value is null when the action is "hide" or "folder".
When the action is "upload" or "start", the MIME type of the file, as specified when the file was uploaded. For "hide" action, always "application/x-bz-hide-marker". For "folder" action, always null.
The custom information that was uploaded with the file. This is a JSON object, holding the name/value pairs that were uploaded with the file.
The name of this file, which can be used with
This is a UTC time when this file was
uploaded. It is a base 10 number of milliseconds since midnight,
January 1, 1970 UTC. This fits in a 64 bit integer such as the type "long"
in the programming language Java. It is intended to be compatible
with Java's time long. For example, it can be passed directly into
the java call Date.setTime(long time).
Unable to start large file.
If possible the server will return a JSON error structure. Errors include:
v2: Consistent file structures (Sept 13, 2018)
v1: Application keys (July 26, 2018)
Incompatible change: After calling b2_authorize_account with an application key that does not have the right permissions, this call will return a 401 Unauthorized.
v1: Original release (September 22, 2015)