b2_delete_bucket
Deletes the bucket specified. Only buckets that contain no version of any files can be deleted.
Request
Request HTTP Headers
Authorization
required
An account authorization token, obtained from
b2_authorize_account
.
The token must have the deleteBuckets
capability.
Request HTTP Message Body Parameters
accountId
required
Your account ID.
bucketId
required
The ID of the bucket to delete.
Response
Response HTTP Status 200
Bucket successfully deleted. The JSON response will contain:
accountId
The account that the bucket is in.
bucketId
The unique ID of the bucket.
bucketName
The unique name of the bucket
bucketType
One of: allPublic
, allPrivate
, restricted
, snapshot
, shared
, or other values added in the future. allPublic
means that anybody
can download the files is the bucket; allPrivate
means that you need
an authorization token to download them; snapshot
means that it's a private bucket containing snapshots created
on the B2 web site.
bucketInfo
The user data stored with this bucket.
corsRules
The CORS rules for this bucket. See CORS Rules for an overview and the rule structure.
fileLockConfiguration
The Object Lock configuration for this bucket.
This field is filtered based on application key capabilities;
readBucketRetentions
capability is required to
access the value. See Object
Lock for more details on response structure.
defaultServerSideEncryption
The default
bucket Server-Side
Encryption settings for new files uploaded to this
bucket.
This field is filtered based on application key capabilities;
readBucketEncryption
capability is required
to access the value. See
Server-Side
Encryption for more details on response structure.
lifecycleRules
The list of lifecycle rules for this bucket. See Lifecycle Rules for an overview and the rule structure.
replicationConfiguration
The list of replication rules for this bucket. See Cloud Replication Rules for an overview and the rule structure.
revision
A counter that is updated every time the bucket is modified,
and can be used with the ifRevisionIs
parameter
to b2_update_bucket to
prevent colliding, simultaneous updates.
options
When present and set to s3
, the bucket can be
accessed through the S3 Compatible API.
Response Errors
Bucket not deleted.
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. |
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
ACCOUNT_ID=... # Comes from your account page on the Backblaze web site
ACCOUNT_AUTHORIZATION_TOKEN=... # Comes from the b2_authorize_account call
API_URL=... # Comes from the b2_authorize_account call
BUCKET_ID=... # The ID of the bucket you want to delete
curl -H "Authorization: $ACCOUNT_AUTHORIZATION_TOKEN" \
-d '{"accountId":"ACCOUNT_ID", "bucketId":"BUCKET_ID"}' \
"$API_URL/b2api/v2/b2_delete_bucket"
Output
{
"accountId": "12f634bf3cbz",
"bucketId": "4a48fe8875c6214145260818",
"accountId": "12f634bf3cby",
"bucketName": "any_name_you_pick",
"bucketType": "allPrivate",
"corsRules": [],
"defaultServerSideEncryption": {
"isClientAuthorizedToRead": true,
"value": {
"algorithm": null,
"mode": null
}
},
"fileLockConfiguration": {
"isClientAuthorizedToRead": true,
"value": {
"defaultRetention": {
"mode": null,
"period": null
},
"isFileLockEnabled": true
}
},
"lifecycleRules": [],
"options": [],
"revision": 5
}
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 accountAuthorizationToken = ""; // Provided by b2_authorize_account
String accountId = ""; // Obtained from your B2 account page.
String bucketId = ""; // Provided by b2_authorize_account, b2_list_buckets, and b2_update_bucket
HttpURLConnection connection = null;
String postParams = "{\"accountId\":\"" + accountId + "\",\"bucketId\":\"" + bucketId + "\"}";
byte postData[] = postParams.getBytes(StandardCharsets.UTF_8);
try {
URL url = new URL(apiUrl + "/b2api/v2/b2_delete_bucket");
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": "4a48fe8875c6214145260818",
"accountId": "12f634bf3cby",
"bucketName": "any_name_you_pick",
"bucketType": "allPrivate",
"corsRules": [],
"defaultServerSideEncryption": {
"isClientAuthorizedToRead": true,
"value": {
"algorithm": null,
"mode": null
}
},
"fileLockConfiguration": {
"isClientAuthorizedToRead": true,
"value": {
"defaultRetention": {
"mode": null,
"period": null
},
"isFileLockEnabled": true
}
},
"lifecycleRules": [],
"options": [],
"revision": 5
}
Code
import json
import urllib2
ACCOUNT_ID = "..." # Comes from your account page on the Backblaze web site
ACCOUNT_AUTHORIZATION_TOKEN = "..." # Comes from the b2_authorize_account call
BUCKET_ID = "..." # Comes from the b2_list_buckets call
API_URL = "..." # Comes from the b2_authorize_account call
url = API_URL + '/b2api/v2/b2_delete_bucket'
params = {
'accountId': ACCOUNT_ID,
'bucketId': BUCKET_ID
}
headers = {
'Authorization': ACCOUNT_AUTHORIZATION_TOKEN
}
request = urllib2.Request(url, json.dumps(params), headers)
response = urllib2.urlopen(request)
print response.read()
response.close()
Output
{
"accountId": "12f634bf3cbz",
"bucketId": "4a48fe8875c6214145260818",
"accountId": "12f634bf3cby",
"bucketName": "any_name_you_pick",
"bucketType": "allPrivate",
"corsRules": [],
"defaultServerSideEncryption": {
"isClientAuthorizedToRead": true,
"value": {
"algorithm": null,
"mode": null
}
},
"fileLockConfiguration": {
"isClientAuthorizedToRead": true,
"value": {
"defaultRetention": {
"mode": null,
"period": null
},
"isFileLockEnabled": true
}
},
"lifecycleRules": [],
"options": [],
"revision": 5
}
Code
import Foundation
let apiUrl = "" // Provided by b2_authorize_account
let accountAuthorizationToken = "" // Provided by b2_authorize_account
let accountId = "" // Obtained from your B2 account page.
let bucketId = "" // Provided by b2_authorize_account, b2_list_buckets, and b2_update_bucket
// Create the request
var request = URLRequest(url: URL(string: "\(apiUrl)/b2api/v2/b2_delete_bucket")!)
request.httpMethod = "POST"
request.addValue(accountAuthorizationToken, forHTTPHeaderField: "Authorization")
request.httpBody = "{\"accountId\":\"\(accountId)\", \"bucketId\":\"\(bucketId)\"}".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": "4a48fe8875c6214145260818",
"accountId": "12f634bf3cby",
"bucketName": "any_name_you_pick",
"bucketType": "allPrivate",
"corsRules": [],
"defaultServerSideEncryption": {
"isClientAuthorizedToRead": true,
"value": {
"algorithm": null,
"mode": null
}
},
"fileLockConfiguration": {
"isClientAuthorizedToRead": true,
"value": {
"defaultRetention": {
"mode": null,
"period": null
},
"isFileLockEnabled": true
}
},
"lifecycleRules": [],
"options": [],
"revision": 5
}
Code
require 'json'
require 'net/http'
api_url = "" # Provided by b2_authorize_account
account_authorization_token = "" # Provided by b2_authorize_account
account_id = "" # Obtained from your B2 account page.
bucket_id = "" # Provided by b2_authorize_account, b2_list_buckets, and b2_update_bucket
uri = URI("#{api_url}/b2api/v2/b2_delete_bucket")
req = Net::HTTP::Post.new(uri)
req.add_field("Authorization","#{account_authorization_token}")
req.body = "{\"accountId\":\"#{account_id}\",\"bucketId\":\"#{bucket_id}\"}"
req = Net::HTTP::POST.new(uri)
req.basic_auth(accountId, application_key)
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
json = res.body
when Net::HTTPRedirection then
fetch(res['location'], limit - 1)
else
res.error!
end
json
Output
{
"accountId": "12f634bf3cbz",
"bucketId": "4a48fe8875c6214145260818",
"accountId": "12f634bf3cby",
"bucketName": "any_name_you_pick",
"bucketType": "allPrivate",
"corsRules": [],
"defaultServerSideEncryption": {
"isClientAuthorizedToRead": true,
"value": {
"algorithm": null,
"mode": null
}
},
"fileLockConfiguration": {
"isClientAuthorizedToRead": true,
"value": {
"defaultRetention": {
"mode": null,
"period": null
},
"isFileLockEnabled": true
}
},
"lifecycleRules": [],
"options": [],
"revision": 5
}
Code
String apiUrl = "API_URL"; //Provided by b2_authorize_account
String accountAuthorizationToken = "ACCOUNT_AUTHORIZATION_TOKEN"; //Provided by b2_authorize_account
String accountId = "ACCOUNT_ID"; //B2 Cloud Storage AccountID
String bucketId = "BUCKET_ID; //The unique bucket ID
HttpWebRequest webRequest = (HttpWebRequest)WebRequest.Create(apiUrl + "/b2api/v2/b2_delete_bucket");
string body =
"{\"accountId\":\"" + accountId + "\",\n" +
"\"bucketId\":\"" + bucketId + "\"}";
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": "4a48fe8875c6214145260818",
"accountId": "12f634bf3cby",
"bucketName": "any_name_you_pick",
"bucketType": "allPrivate",
"corsRules": [],
"defaultServerSideEncryption": {
"isClientAuthorizedToRead": true,
"value": {
"algorithm": null,
"mode": null
}
},
"fileLockConfiguration": {
"isClientAuthorizedToRead": true,
"value": {
"defaultRetention": {
"mode": null,
"period": null
},
"isFileLockEnabled": true
}
},
"lifecycleRules": [],
"options": [],
"revision": 5
}
Code
$account_id = ""; // Obtained from your B2 account page
$api_url = ""; // From b2_authorize_account call
$auth_token = ""; // From b2_authorize_account call
$bucket_id = ""; // The ID of the bucket you want to delete
$session = curl_init($api_url . "/b2api/v2/b2_delete_bucket");
// Add post fields
$data = array("accountId" => $account_id, "bucketId" => $bucket_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": "4a48fe8875c6214145260818",
"accountId": "12f634bf3cby",
"bucketName": "any_name_you_pick",
"bucketType": "allPrivate",
"corsRules": [],
"defaultServerSideEncryption": {
"isClientAuthorizedToRead": true,
"value": {
"algorithm": null,
"mode": null
}
},
"fileLockConfiguration": {
"isClientAuthorizedToRead": true,
"value": {
"defaultRetention": {
"mode": null,
"period": null
},
"isFileLockEnabled": true
}
},
"lifecycleRules": [],
"options": [],
"revision": 5
}