b2_get_file_info
Gets information about one file stored in B2.
This will return an error if called on a non-existent file ID or if called on an unfinished large file.Request
Request HTTP Headers
Authorization
required
The account authorization token returned by b2_authorize_account
.
The token must have the readFiles
capability.
Request HTTP Message Body Parameters
fileId
required
The ID of the file, as returned by
b2_upload_file
,
b2_hide_file
,
b2_list_file_names
, or
b2_list_file_versions
.
Response
Response HTTP Status 200
File info returned as a JSON response:
accountId
The account that owns the file.
action
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.
bucketId
The bucket that the file is in.
contentLength
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".
contentSha1
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".
contentMd5
optional
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".
contentType
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.
fileId
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
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
The name of this file, which can be used with
b2_download_file_by_name
.
fileRetention
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".
legalHold
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".
replicationStatus
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
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".
uploadTimestamp
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".
Response Errors
If possible the server will return a JSON error structure. Errors include:
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. |
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. |
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 |
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. |
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)
Sample Code
Code
FILE_ID=... # The ID of the file you want to get info on
ACCOUNT_AUTHORIZATION_TOKEN = "" # Provided by b2_authorize_account
curl -H 'Authorization: $ACCOUNT_AUTHORIZATION_TOKEN' \
-D '{"fileId":"$FILE_ID"}' \
https://apiNNN.backblazeb2.com/b2api/v2/b2_get_file_info
Output
{
"accountId": "12f634bf3cbz",
"bucketId": "e73ede9c9c8412db49f60715",
"contentLength": 122573,
"contentSha1": "a01a21253a07fb08a354acd30f3a6f32abb76821",
"contentType": "image/jpeg",
"fileId": "4_ze73ede9c9c8412db49f60715_f100b4e93fbae6252_d20150824_m224353_c900_v8881000_t0001",
"fileInfo": {},
"fileName": "akitty.jpg",
"fileRetention": {
"isClientAuthorizedToRead": true,
"value": {
"mode": null,
"retainUntilTimestamp": null
}
},
"legalHold": {
"isClientAuthorizedToRead": true,
"value": null
},
"serverSideEncryption": {
"algorithm": "AES256",
"mode": "SSE-B2"
}
}
Code
import java.io.*;
import java.util.*;
import javax.json.*;
import java.net.HttpURLConnection;
import java.net.URL;
String apiUrl = ""; // Provided by b2_authorize_account
String fileId = ""; // The ID of the file you want to get info on
String accountAuthorizationToken = ""; // Provided by b2_authorize_account
HttpURLConnection connection = null;
String postParams = "{\"fileId\":\"" + fileId + "\"}";
byte postData[] = postParams.getBytes(StandardCharsets.UTF_8);
try {
URL url = new URL(apiUrl + "/b2api/v2/b2_get_file_info");
connection = (HttpURLConnection)url.openConnection();
connection.setRequestMethod("POST");
connection.setRequestProperty("Authorization", accountAuthorizationToken);
connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
connection.setRequestProperty("charset", "utf-8");
connection.setRequestProperty("Content-Length", Integer.toString(postData.length));
connection.setDoOutput(true);
DataOutputStream writer = new DataOutputStream(connection.getOutputStream());
writer.write(postData);
String jsonResponse = myInputStreamReader(connection.getInputStream());
System.out.println(jsonResponse);
} catch (Exception e) {
e.printStackTrace();
} finally {
connection.disconnect();
}
static public String myInputStreamReader(InputStream in) throws IOException {
InputStreamReader reader = new InputStreamReader(in);
StringBuilder sb = new StringBuilder();
int c = reader.read();
while (c != -1) {
sb.append((char)c);
c = reader.read();
}
reader.close();
return sb.toString();
}
Output
{
"accountId": "12f634bf3cbz",
"bucketId": "e73ede9c9c8412db49f60715",
"contentLength": 122573,
"contentSha1": "a01a21253a07fb08a354acd30f3a6f32abb76821",
"contentType": "image/jpeg",
"fileId": "4_ze73ede9c9c8412db49f60715_f100b4e93fbae6252_d20150824_m224353_c900_v8881000_t0001",
"fileInfo": {},
"fileName": "akitty.jpg",
"fileRetention": {
"isClientAuthorizedToRead": true,
"value": {
"mode": null,
"retainUntilTimestamp": null
}
},
"legalHold": {
"isClientAuthorizedToRead": true,
"value": null
},
"serverSideEncryption": {
"algorithm": "AES256",
"mode": "SSE-B2"
}
}
Code
import json
import urllib2
api_url = "" # Provided by b2_authorize_account
file_id = "" # The ID of the file you want to get info on
account_authorization_token = "" # Provided by b2_authorize_account
request = urllib2.Request(
'%s/b2api/v2/b2_get_file_info' % api_url,
json.dumps({ 'fileId' : file_id }),
headers = { 'Authorization': account_authorization_token }
)
response = urllib2.urlopen(request)
response_data = json.loads(response.read())
response.close()
Output
{
"accountId": "12f634bf3cbz",
"bucketId": "e73ede9c9c8412db49f60715",
"contentLength": 122573,
"contentSha1": "a01a21253a07fb08a354acd30f3a6f32abb76821",
"contentType": "image/jpeg",
"fileId": "4_ze73ede9c9c8412db49f60715_f100b4e93fbae6252_d20150824_m224353_c900_v8881000_t0001",
"fileInfo": {},
"fileName": "akitty.jpg",
"fileRetention": {
"isClientAuthorizedToRead": true,
"value": {
"mode": null,
"retainUntilTimestamp": null
}
},
"legalHold": {
"isClientAuthorizedToRead": true,
"value": null
},
"serverSideEncryption": {
"algorithm": "AES256",
"mode": "SSE-B2"
}
}
Code
import Foundation
let apiUrl = "" // Provided by b2_authorize_account
let fileId = "" // The ID of the file you want to get info on
let accountAuthorizationToken = "" // Provided by b2_authorize_account
// Create the request
var request = URLRequest(url: URL(string: "\(apiUrl)/b2api/v2/b2_get_file_info")!)
request.httpMethod = "POST"
request.addValue(accountAuthorizationToken, forHTTPHeaderField: "Authorization")
request.httpBody = "{\"fileId\":\"\(fileId)\"}".data(using: .utf8)!
// Create the task
let task = URLSession.shared.dataTask(with: request) { (data, response, error) in
if let data = data {
let json = String(data: data, encoding: .utf8)
print("\(json!)")
}
}
// Start the task
task.resume()
// Swift 4.1 (swiftlang-902.0.48 clang-902.0.37.1) Xcode 9.3.1 (9E501)
Output
{
"accountId": "12f634bf3cbz",
"bucketId": "e73ede9c9c8412db49f60715",
"contentLength": 122573,
"contentSha1": "a01a21253a07fb08a354acd30f3a6f32abb76821",
"contentType": "image/jpeg",
"fileId": "4_ze73ede9c9c8412db49f60715_f100b4e93fbae6252_d20150824_m224353_c900_v8881000_t0001",
"fileInfo": {},
"fileName": "akitty.jpg",
"fileRetention": {
"isClientAuthorizedToRead": true,
"value": {
"mode": null,
"retainUntilTimestamp": null
}
},
"legalHold": {
"isClientAuthorizedToRead": true,
"value": null
},
"serverSideEncryption": {
"algorithm": "AES256",
"mode": "SSE-B2"
}
}
Code
require 'json'
require 'net/http'
api_url = "" # Provided by b2_authorize_account
file_id = "" # The ID of the file you want to get info on
account_authorization_token = "" # Provided by b2_authorize_account
uri = URI.join("#{api_url}/b2api/v2/b2_get_file_info")
req = Net::HTTP::Post.new(uri)
req.add_field("Authorization","#{account_authorization_token}")
req.body = "{\"fileId\":\"#{file_id}\"}"
http = Net::HTTP.new(req.uri.host, req.uri.port)
http.use_ssl = true
res = http.start {|http| http.request(req)}
case res
when Net::HTTPSuccess then
res.body
when Net::HTTPRedirection then
fetch(res['location'], limit - 1)
else
res.error!
end
Output
{
"accountId": "12f634bf3cbz",
"bucketId": "e73ede9c9c8412db49f60715",
"contentLength": 122573,
"contentSha1": "a01a21253a07fb08a354acd30f3a6f32abb76821",
"contentType": "image/jpeg",
"fileId": "4_ze73ede9c9c8412db49f60715_f100b4e93fbae6252_d20150824_m224353_c900_v8881000_t0001",
"fileInfo": {},
"fileName": "akitty.jpg",
"fileRetention": {
"isClientAuthorizedToRead": true,
"value": {
"mode": null,
"retainUntilTimestamp": null
}
},
"legalHold": {
"isClientAuthorizedToRead": true,
"value": null
},
"serverSideEncryption": {
"algorithm": "AES256",
"mode": "SSE-B2"
}
}
Code
String apiUrl = "API_URL"; //Provided by b2_authorize_account
String accountAuthorizationToken = "ACCOUNT_AUTHORIZATION_TOKEN"; //Provided by b2_authorize_account
String fileId = "FILE_ID"; //The unique file ID
HttpWebRequest webRequest = (HttpWebRequest)WebRequest.Create(apiUrl + "/b2api/v2/b2_get_file_info");
string body = "{\"fileId\":\"" + fileId + "\"}";
var data = Encoding.UTF8.GetBytes(body);
webRequest.Method = "POST";
webRequest.Headers.Add("Authorization", accountAuthorizationToken);
webRequest.ContentType = "application/json; charset=utf-8";
webRequest.ContentLength = data.Length;
using (var stream = webRequest.GetRequestStream())
{
stream.Write(data, 0, data.Length);
stream.Close();
}
WebResponse response = (HttpWebResponse)webRequest.GetResponse();
var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();
response.Close();
Console.WriteLine(responseString);
Output
{
"accountId": "12f634bf3cbz",
"bucketId": "e73ede9c9c8412db49f60715",
"contentLength": 122573,
"contentSha1": "a01a21253a07fb08a354acd30f3a6f32abb76821",
"contentType": "image/jpeg",
"fileId": "4_ze73ede9c9c8412db49f60715_f100b4e93fbae6252_d20150824_m224353_c900_v8881000_t0001",
"fileInfo": {},
"fileName": "akitty.jpg",
"fileRetention": {
"isClientAuthorizedToRead": true,
"value": {
"mode": null,
"retainUntilTimestamp": null
}
},
"legalHold": {
"isClientAuthorizedToRead": true,
"value": null
},
"serverSideEncryption": {
"algorithm": "AES256",
"mode": "SSE-B2"
}
}
Code
$api_url = ""; // From b2_authorize_account call
$auth_token = ""; // From b2_authorize_account call
$file_id = ""; // The id of the file
$session = curl_init($api_url . "/b2api/v2/b2_get_file_info");
// Add post fields
$data = array("fileId" => $file_id);
$post_fields = json_encode($data);
curl_setopt($session, CURLOPT_POSTFIELDS, $post_fields);
// Add headers
$headers = array();
$headers[] = "Authorization: " . $auth_token;
curl_setopt($session, CURLOPT_HTTPHEADER, $headers);
curl_setopt($session, CURLOPT_POST, true); // HTTP POST
curl_setopt($session, CURLOPT_RETURNTRANSFER, true); // Receive server response
$server_output = curl_exec($session); // Let's do this!
curl_close ($session); // Clean up
echo ($server_output); // Tell me about the rabbits, George!
Output
{
"accountId": "12f634bf3cbz",
"bucketId": "e73ede9c9c8412db49f60715",
"contentLength": 122573,
"contentSha1": "a01a21253a07fb08a354acd30f3a6f32abb76821",
"contentType": "image/jpeg",
"fileId": "4_ze73ede9c9c8412db49f60715_f100b4e93fbae6252_d20150824_m224353_c900_v8881000_t0001",
"fileInfo": {},
"fileName": "akitty.jpg",
"fileRetention": {
"isClientAuthorizedToRead": true,
"value": {
"mode": null,
"retainUntilTimestamp": null
}
},
"legalHold": {
"isClientAuthorizedToRead": true,
"value": null
},
"serverSideEncryption": {
"algorithm": "AES256",
"mode": "SSE-B2"
}
}