Contents x
b2_list_file_versions
    • Print
    • Dark
      Light
    Contents

    b2_list_file_versions

      • Print
      • Dark
        Light
      Article summary

      Get
      /b2api/v3/b2_list_file_versions

      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 all versions of all files contained in one bucket

      Lists file versions in a bucket in alphabetical order by file name, and by reverse of date/time uploaded for versions of files with the same 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" and "nextFileId" that can be used as the starting point for the next call.

      This call supports the same options for matching a file name prefix and for grouping files into folders as b2_list_file_names. See that page for more details.

      The application key you authorized with may restrict access to some files. See b2_list_file_names for details.

      API Versions

      v2: Object Lock (May 11, 2021)

      Now returns fileRetention and legalHold.

      v2: Server-Side Encryption (March 5, 2021)

      Now returns serverSideEncryption.

      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.

      Now returns accountId and bucketId. Does not return size any more; use contentLength instead.

      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.

      1: 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.

      startFileName
      string

      The first file name to return.


      If there are no files with this name, the first version of the file with the first name after the given name will be the first in the list.


      If startFileId is also specified, the name-and-id pair is the starting point. If there is a file with the given name and ID, it will be first in the list. Otherwise, the first file version that comes after the given name and ID will be first in the list.

      startFileId
      string

      The first file ID to return. startFileName must also be provided if startFileId is specified. (See startFileName.)

      maxFileCount
      integer

      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.


      NOTE: b2_list_file_versions is a Class C transaction (see Pricing). The maximum number of files returned per transaction is 1000. If you set maxFileCount to more than 1000 and more than 1000 are returned, the call will be billed as multiple transactions, as if you had made requests in a loop asking for 1000 at a time. For example: if you set maxFileCount to 10000 and 3123 items are returned, you will be billed for 4 Class C transactions.

      prefix
      string

      Files returned will be limited to those with the given prefix. Defaults to the empty string, which matches all files.

      delimiter
      string

      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.

      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 file or folder. (See below.)

      Example[ { "accountId": "ACCOUNT_ID", "action": "upload", "bucketId": "b2f6f21365e1d29f6c580f18", "contentLength": 7, "contentSha1": "dc724af18fbdd4e59189f5fe768a5f8311527050", "contentType": "text/plain", "fileId": "4_zb2f6f21365e1d29f6c580f18_f10904e5ca06493a1_d20180914_m223119_c002_v0001094_t0002", "fileInfo": { "src_last_modified_millis": "1536964184056" }, "fileName": "testing.txt", "fileRetention": { "isClientAuthorizedToRead": true, "value": { "mode": null, "retainUntilTimestamp": null } }, "legalHold": { "isClientAuthorizedToRead": true, "value": null }, "serverSideEncryption": { "algorithm": "AES256", "mode": "SSE-C" }, "uploadTimestamp": "1536964279000" }, { "accountId": "ACCOUNT_ID", "action": "upload", "bucketId": "b2f6f21365e1d29f6c580f18", "contentLength": 8, "contentSha1": "596b29ec9afea9e461a20610d150939b9c399d93", "contentType": "text/plain", "fileId": "4_zb2f6f21365e1d29f6c580f18_f10076875fe98d4af_d20180914_m223128_c002_v0001108_t0050", "fileInfo": { "src_last_modified_millis": "1536964200750" }, "fileName": "testing2.txt", "fileRetention": { "isClientAuthorizedToRead": true, "value": { "mode": null, "retainUntilTimestamp": null } }, "legalHold": { "isClientAuthorizedToRead": true, "value": null }, "serverSideEncryption": { "algorithm": "AES256", "mode": "SSE-B2" }, "uploadTimestamp": "1536964288000" } ]
      object
      accountId
      string

      The account that owns the file.

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

      Exampleupload
      bucketId
      string

      The bucket that the file is in.

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

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

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

      Exampletext/plain
      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".

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

      Example{ "src_last_modified_millis": "1536964200750" }
      fileName
      string

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

      Exampletesting.txt
      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
      string

      Encryption algorithm type.

      ExampleAES256
      mode
      string

      The type of server-side encryption used.

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

      Example1536964279000
      nextFileName
      string

      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 version in the bucket.

      Example
      nextFileId
      string

      What to pass in to startFileId 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 file, but using it is guaranteed to find the next file version in the bucket.

      Example
      400
      statuscodedescription
      400bad_bucket_idThe requested bucket ID does not match an existing bucket.
      400bad_requestThe request had the wrong fields or illegal values. The message returned with the error will describe the problem.
      400invalid_bucket_idInvalid bucketId: <bucketId>
      400out_of_rangemaxFileCount out of range: <maxFileCount>
      400invalid_file_idInvalid startFileId: <startFileId>
      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
      statuscodedescription
      401bad_auth_tokenThe auth token used is not valid. Call b2_authorize_account again to either get a new one, or an error message describing the problem.
      401expired_auth_tokenThe auth token used has expired. Call b2_authorize_account again to get a new one.
      401unauthorizedThe 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
      statuscodedescription
      403transaction_cap_exceededTransaction 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.
      503
      statuscodedescription
      503bad_requestTimed out while iterating and skipping files
      Was this article helpful?
      What's Next