Contents x
b2_delete_file_version
    • Print
    • Dark
      Light
    Contents

    b2_delete_file_version

      • Print
      • Dark
        Light
      Article Summary

      Post
      /b2api/v3/b2_delete_file_version

      Deletes one version of a file

      If the version you delete is the latest version, and there are older versions, then the most recent older version will become the current version, and be the one that you'll get when downloading by name. See File Versions for more details.

      When used on an unfinished large file, this call has the same effect as b2_cancel_large_file.

      API Versions

      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)

      PLEASE NOTE:

      This API endpoint can be called using a GET request by converting the parameters in the request body to query parameters.

      Header parameters
      Authorization
      stringRequired

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

      Body parameters
      object
      fileName
      string Required

      The name of the file.

      ExampleFILE_NAME
      fileId
      string Required

      The ID of the file, as returned by b2_upload_file, b2_list_file_names, or b2_list_file_versions.

      ExampleFILE_ID
      bypassGovernance
      boolean

      Must be specified and set to true if deleting a file version protected by Object Lock governance mode retention settings. Setting the value requires the bypassGovernance application key capability. See Object Lock for more information.

      ExampleTrue
      Responses
      200

      The request succeeded.

      object
      fileId
      string

      The unique ID of the file version that was deleted.

      Example4_h4a48fe8875c6214145260818_f000000000000472a_d20140104_m032022_c001_v0000123_t0104
      fileName
      string

      The name of the file.

      Exampletyping_test.txt
      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.
      400file_not_presentFile not present: <fileName> <fileId>.
      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.
      401access_deniedAccess Denied. The delete was not allowed because Object Lock is enabled on the file.
      Was this article helpful?
      What's Next