Source Code Bundles
Lists the names of all files in a bucket, starting at a given name.
This call returns at most 1000 file names per transaction, but it can be called repeatedly to scan through all of the file names in a bucket. Each time you call, it returns a "nextFileName" that can be used as the starting point for the next call.
There may be many file versions for the same name, but this
call will return each name only once. Files that have been
hidden will not be returned; to see all versions of a file,
including hide markers, use
To go through all of the file names in a bucket, use a loop like this:
startFileName = null while true: response = b2_list_file_names(bucketId = ..., startFileName = startFileName) for file in response.files: process_one_file_name(file) if response.startFileName == null: break startFileName = response.nextFileName
Prefixes and Delimiters
You can optionally specify a file name prefix, which will restrict the results to only files starting with that prefix.
Another option is to specify a delimiter (usually "/") for folder names. If found after the file name prefix, the delimiter is treated as the end of a folder name, and the folder name is returned, replacing all of the files in that folder. Each item returned is either an "upload" (a file) or a "folder" (representing one or many files).
As an example, if you have these files in your bucket:
photos/alice.jpg photos/alfred.jpg photos/cats/fluffy.jpg photos/cats/mittens.jpg photos/dogs/spot.jpg photos/lilly.jpg
With the default prefix of "" and no delimiter, you get all of the files:
upload photos/alice.jpg upload photos/alfred.jpg upload photos/cats/fluffy.jpg upload photos/cats/mittens.jpg upload photos/dogs/spot.jpg upload photos/lilly.jpg
If you use a prefix of "photos/c" you will get the same list as if you specify "photos/cats/" as the prefix:
upload photos/cats/fluffy.jpg upload photos/cats/mittens.jpg
With a prefix of "" (meaning all files), and a delimiter of "/", you would get:
With a prefix of "photos/", and a delimiter of "/", you would get:
upload photos/alice.jpg upload photos/alfred.jpg folder photos/cats/ folder photos/dogs/ upload photos/lilly.jpg
Bucket and Prefix Restrictions
When using an application key that is restricted to one bucket, and to files matching a name prefix in that bucket, you must only ask about those files. Listing files in other buckets is not allowed. Listing files that do not match the prefix is not allowed, so you must specify a prefix that is at least as restrictive as the one in the application key.
Request HTTP Headers
The account authorization token returned by
Request HTTP Message Body Parameters
The bucket to look for file names in. Returned by b2_list_buckets.
The first file name to return. If there is a file with this name, it will be returned in the list. If not, the first file name after this the first one after this name.
The maximum number of files to return from this call. The
default value is 100, and the maximum is 10000. Passing
in 0 means to use the default of 100.
Files returned will be limited to those with the given prefix. Defaults to the empty string, which matches all files.
Files returned will be limited to those within the top folder, or any one subfolder. Defaults to NULL. Folder names will also be returned. The delimiter character will be used to "break" file names into folders.
Response HTTP Status 200
List of file names as JSON:
An array of objects, each one describing one file or folder. (See below.)
What to pass in to startFileName 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 name of an actual file, but using it is guaranteed to find the next file in the bucket.
And each of the files is:
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).
If possible the server will return a JSON error structure. Errors include:
v2: Remove application key workaround (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.
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: Original release (September 22, 2015)Original release.