b2_list_unfinished_large_files

Print
Dark
Light

b2_list_unfinished_large_files

Print
Dark
Light

Article Summary

Share feedback

Thanks for sharing your feedback!

Get

/b2api/v3/b2_list_unfinished_large_files

PLEASE NOTE:

This API request is now being described as a GET request and not a POST request, as was the case in previous versions of our documentation.

We made this update because we believe that an API call that retrieves data and does not alter state is more accurately represented as a GET request.

You may still make a POST request to this endpoint by simply submitting a JSON-formatted request body containing the parameters, with Content-Type set to application/json.

Lists information about large file uploads that have been started, but have not been finished or canceled

Uploads are listed in the order they were started, with the oldest one first.

This call returns at most 1000 entries, but it can be called repeatedly to scan through all of the uploads for a bucket. Each time you call, it returns a nextFileId that can be used as the starting point for the next call.

API Versions

v2: Remove application key workaround, consistent file structures (Sept 13, 2018)

Listing file names will always return all of the file names you ask for. If your application key has a file name prefix restriction, and you ask for files outside that prefix, the call is unauthorized.

Now returns action ("start"), contentLength (0), and contentSha1 ("none") in files returned.

v1: Workaround for existing applications and application keys (August 9, 2018)

When using an application key with a file name prefix restriction, a request to list files will be filtered to show only files allowed by the application key.

v1: Application keys (July 26, 2018)

New optional namePrefix parameter to b2_list_unfinished_large_files so that you can restricted the results to just some files. This is especially useful with application keys that have file name restrictions.

v1: Original release (September 22, 2015)

Original release.

Header parameters

Authorization

stringRequired

An account authorization token, obtained from b2_authorize_account.
The token must have the listFiles capability.

Query parameters

bucketId

stringRequired

The bucket to look for file names in.

namePrefix

string

When a namePrefix is provided, only files whose names match the prefix will be returned. Whe using an application key that is restricted to a name prefix, you must provide a prefix here that is at least as restrictive.

startFileId

string (uuid)

The first upload to return. If there is an upload with this ID, it will be returned in the list. If not, the first upload after this the first one after this ID.

maxFileCount

integer

The maximum number of files to return from this call. The default value is 100, and the maximum allowed is 100.

Responses

200

The request succeeded.

The response headers include the Content-Type that was specified when the file was uploaded. They also include the X-Bz-FileName and X-Bz-Content-Sha1 headers, plus X-Bz-Info-* headers for any custom file info that was provided with the upload. The X-Bz-FileName uses percent-encoding, as if it were a URL parameter.

Expand All

object

files

Array of object

An array of objects, each one describing one unfinished file. (See below.)

object

accountId

string

The account that owns the file.

ExampleYOUR_ACCOUNT_ID

action

string

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 b2_list_file_names. "folder" is used to indicate a virtual folder when listing files.

Examplestart

bucketId

string

The bucket that the file is in.

Example4a48fe8875c6214145260818

contentLength

integer

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".

Example0

contentSha1

string

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".

Examplenone

contentMd5

string

The MD5 of the bytes stored in the file as a 32-digit hex string. Not all files have an MD5 checksum, so this field is optional, and set to null for files that do not have one. Large files do not have MD5 checksums, and the value is null. The value is also null when the action is "hide" or "folder".

Exampledc724af18fbdd4e59189f5fe768a5f8311527050

contentType

string

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.

Exampleapplication/x-bz-hide-marker

fileId

string

The unique identifier for this version of this file. Used with b2_get_file_info, b2_download_file_by_id, and b2_delete_file_version. The value is null when for action "folder"

fileInfo

object

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.

fileName

string

The name of this file, which can be used with b2_download_file_by_name.

fileRetention

object

The Object Lock retention settings for this file, if any. This field is filtered based on application key capabilities; the readFileRetentions capability is required to access the value. See Object Lock for more details on response structure. This field is omitted when the action is "hide" or "folder".

Example{ "isClientAuthorizedToRead": true, "value": { "mode": null, "retainUntilTimestamp": null } }

isClientAuthorizedToRead

boolean

value

object

mode

string

retainUntilTimestamp

integer

legalHold

object

The Object Lock legal hold status for this file, if any. This field is filtered based on application key capabilities; the readFileLegalHolds capability is required to access the value. See Object Lock for more details on response structure. This field is omitted when the action is "hide" or "folder".

Example{ "isClientAuthorizedToRead": true, "value": "off" }

isClientAuthorizedToRead

boolean

value

string

replicationStatus

string

The Replication Status for this file, if any. This will show either PENDING, COMPLETED, FAILED, or REPLICA For details see Cloud Replication. This field is omitted when the file is not part of a replication rule.

serverSideEncryption

object

When the file is encrypted with Server-Side Encryption, the mode ("SSE-B2" or "SSE-C") and algorithm used to encrypt the data. If the file is not encrypted with Server-Side Encryption, then both mode and algorithm will be null. This field is omitted when the action is "hide" or "folder".

Example{ "algorithm": null, "mode": null }

algorithm

string

mode

string

uploadTimestamp

integer

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). Always 0 when the action is "folder".

nextFileId

string

What to pass in to startUploadId for the next search to continue where this one left off, or null if there are no more files. Note this this may not be the ID of an actual upload, but using it is guaranteed to find the next upload.

Example{ "accountId": "YOUR_ACCOUNT_ID", "action": "start", "bucketId": "b2f6f21365e1d29f6c580f18", "contentLength": 0, "contentSha1": "none", "contentType": "application/zip", "fileId": "4_zb2f6f21365e1d29f6c580f18_f20150c1fda5f4c8d_d20180919_m215912_c002_v0001110_t0050", "fileInfo": {}, "fileName": "~/Downloads/512MB.zip", "fileRetention": { "isClientAuthorizedToRead": true, "value": { "mode": null, "retainUntilTimestamp": null } }, "legalHold": { "isClientAuthorizedToRead": true, "value": null }, "serverSideEncryption": { "algorithm": null, "mode": null }, "uploadTimestamp": 1537394352000 }

400

status	code	description
400	bad_bucket_id	The requested bucket ID does not match an existing bucket.
400	bad_request	The request had the wrong fields or illegal values. The message returned with the error will describe the problem.

object

status

integer

The numeric HTTP status code. Always matches the status in the HTTP response.

Example400

code

string

A single-identifier code that identifies the error.

Exampleinvalid_bucket_name

message

string

A human-readable message, in English, saying what went wrong.

Examplebucket name is too long

401

status	code	description
401	bad_auth_token	The auth token used is not valid. Call b2_authorize_account again to either get a new one, or an error message describing the problem.
401	expired_auth_token	The auth token used has expired. Call b2_authorize_account again to get a new one.
401	unauthorized	The auth token used is valid, but does not authorize this call with these parameters. The capabilities of an auth token are determined by the application key used with b2_authorize_account.

403

status	code	description
403	transaction_cap_exceeded	Transaction cap exceeded. To increase your cap, sign in to your B2 Cloud Storage account online. Then select the Caps & Alerts link in the B2 Cloud Storage section of the sidebar.

Was this article helpful?

What's Next

b2_start_large_file