Copies an entire file
When calling b2_copy_file, by default the entire source file will be copied to the destination. If you wish, you may supply a range param to only copy a portion of the source file over. Note that the resulting file must be less than 5GB. If you wish to create a file larger than 5GB, you must do it in parts with b2_copy_part. See Large Files for more info.
If copying between two buckets, note that they must belong to the same account.
When copying files, you have the option to either copy the source file's metadata over to the new file, OR generate new metadata (but not both). Use the metadataDirective to indicate which strategy you wish to use:
COPYwill set the new file's metadata to be equal to the source file's metadata.
REPLACEwill ignore the source file's metadata, and set what you provide.
Note that a 400 will be returned in the following two scenarios:
contentTypeis set to a non-null value.
contentTypeis not set, or is
This API endpoint can be called using a
GET request by converting the parameters in the request body to query parameters.
An account authorization token, obtained from b2_authorize_account.
The token must have the
writeFiles capability and the
readFiles capability if the bucket is private.
The ID of the source file being copied.
The ID of the bucket where the copied file will be stored. If this is not set, the copied file will be added to the same bucket as the source file. Note that the bucket containing the source file and the destination bucket must belong to the same account.
The name of the new file being created.
The range of bytes to copy. If not provided, the whole source file will be copied.
The strategy for how to populate metadata for the new file. If
COPY is the indicated strategy, then supplying the
fileInfo param is an error.
Must only be supplied if the
REPLACE. The MIME type of the content of the file, which will be returned in the
Content-Type header when downloading the file. Use the
Content-Type b2/x-auto to automatically set the stored
Content-Type post upload. In the case where a file extension is absent or the lookup fails, the
Content-Type is set to
Content-Type mappings can be perused here.
Must only be supplied if the
REPLACE. This field stores the metadata that will be stored with the file. It follows the same rules that are applied to b2_upload_file.
If present, specifies the Object Lock retention settings for the new file. Setting the value requires the
writeFileRetentions capability and that the destination bucket is Object Lock-enabled. See Object Lock for details.
If present, specifies the Object Lock legal hold status for the new file. Setting the value requires the
writeFileLegalHolds capability and that the destination bucket is Object Lock-enabled. Object Lock for details.
If present, specifies the parameters for Backblaze B2 to use for accessing the source file data using Server-Side Encryption. This parameter is required if and only if the source file has been encrypted using Server-Side Encryption with Customer-Managed Keys (SSE-C), and the provided encryption key must match the one with which the source file was encrypted. See Server-Side Encryption for details.
If present, specifies the parameters for Backblaze B2 to use for encrypting the copied data before storing the destination file using Server-Side Encryption. See Server-Side Encryption for details.
The request succeeded.
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 b2_list_file_names. "folder" is used to indicate a virtual folder when listing files.
The unique ID of the bucket.
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".
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".
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 b2_download_file_by_name.
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".
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".
The Replication Status for this file, if any. This will show either
REPLICA For details see Cloud Replication. This field is omitted when the file is not part of a replication rule.
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".
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".
|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.|
|400||cannot_delete_non_empty_bucket||A bucket must be empty before it can be deleted. To delete this bucket, first remove all of the files in the bucket, then try the delete operation again.|
|400||source_too_large||The source file being copied is too large.|
The numeric HTTP status code. Always matches the status in the HTTP response.
A single-identifier code that identifies the error.
A human-readable message, in English, saying what went wrong.
|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||access_denied||The provided customer-managed encryption key is wrong.|
|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.|
|404||not_found||File is not in B2 Cloud Storage.|
|405||method_not_allowed||method not allowed: <HTTP METHOD>|
|408||request_timeout||The service timed out reading the uploaded file|
|416||range_not_satisfiable||The Range header in the request is valid but cannot be satisfied for the file.|