> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.ibee.co.in/docs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.ibee.co.in/docs/_mcp/server.

# Create bucket

POST https://api.ibee.co.in/v1/object-storage/buckets
Content-Type: application/json

Creates an object storage bucket. `region` is required and must match an Object Storage region identifier configured for the target environment. Do not send a compute `site_id`. Requires scope: object-storage.write.

Reference: https://docs.ibee.co.in/docs/api-reference/object-storage/create-bucket

## Authentication

- `Authorization` header (bearer token, required) — IBEE platform API token. Production tokens start with `ibee_prod_key_`; development tokens start with `ibee_dev_key_`. Use a token only with its matching gateway environment.

## Servers

- `https://api.ibee.co.in/v1` (Production, default)
- `https://api.ibee.co.in/v1` (Development)

## Request

### Query parameters

- `workspace_id` (string, required) — The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

### Body (application/json)

This endpoint expects a CreateBucketRequest.

- `name` (string, required) — Unique bucket name within the workspace.
- `region` (string, required) — Required Object Storage region identifier. This must match a region configured for the target environment; it is not a compute `site_id` or display name.
- `is_public` (boolean, optional, default: false) — Whether the bucket allows unauthenticated read access.
- `object_lock_enabled` (boolean, optional, default: false) — Must be `true` when `default_retention` is provided.
- `default_retention` (DefaultRetention, optional) — Optional default object retention. Supply exactly one of `days` or `years`, and set `object_lock_enabled` to `true`.
- `tags` (list of string, optional) — Optional tags stored alongside bucket metadata.

## Response

### 201

Bucket created successfully.

- `name` (string, required) — Unique bucket name within the workspace.
- `is_public` (boolean, required) — Whether the bucket allows unauthenticated read access.
- `region` (string, required, nullable) — Object storage region the bucket lives in.
- `plan` (string, required, nullable) — Storage plan billed for the bucket.
- `status` (string, required, nullable) — Current bucket status.
- `site_id` (string, required, nullable) — Identifier of the site holding the bucket. Placement is managed internally.
- `site_name` (string, required, nullable) — Human-readable name of the site holding the bucket.
- `bucket_lock_enabled` (boolean, required) — Whether object lock is enabled on the bucket.
- `created_at` (datetime, required, nullable)
- `updated_at` (datetime, required, nullable)
- `object_count` (integer, optional) — Number of objects stored in the bucket. Returned by the read and list endpoints only.
- `total_size` (integer, optional) — Total size in bytes of the objects stored in the bucket. Returned by the read and list endpoints only.

## Errors

### 400 Bad Request Error

The request is invalid.

- `detail` (ErrorDetail, optional)

### 401 Unauthorized Error

The API token is missing or invalid.

- `detail` (ErrorDetail, optional)

### 402 Payment Required Error

Billing denied the resource creation request. No resource is provisioned; inspect the error reason, resolve billing, and retry with the same idempotency key where supported.

- `detail` (ErrorDetail, optional)

### 403 Forbidden Error

The token is not allowed to access the workspace or does not have the required scope.

- `detail` (ErrorDetail, optional)

## Types

### DefaultRetention

Optional default object retention. Supply exactly one of `days` or `years`, and set `object_lock_enabled` to `true`.

- `mode` (enum, required)
  - Allowed values: `GOVERNANCE`, `COMPLIANCE`
- `days` (integer, optional, nullable)
- `years` (integer, optional, nullable)

### ErrorDetail

## Examples

**Request**

```json
{
  "name": "production-assets",
  "region": "in-south-2",
  "is_public": false
}
```

**Response**

```json
{
  "name": "production-assets",
  "is_public": false,
  "region": "in-south-2",
  "plan": "standard",
  "status": "active",
  "site_id": "3",
  "site_name": "Hyderabad",
  "bucket_lock_enabled": false,
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "object_count": 42,
  "total_size": 1048576
}
```

**SDK Code**

```python Object Storage_createBucket_example
import requests

url = "https://api.ibee.co.in/v1/object-storage/buckets"

querystring = {"workspace_id":"710995"}

payload = {
    "name": "production-assets",
    "region": "in-south-2",
    "is_public": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers, params=querystring)

print(response.json())
```

```javascript Object Storage_createBucket_example
const url = 'https://api.ibee.co.in/v1/object-storage/buckets?workspace_id=710995';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"production-assets","region":"in-south-2","is_public":false}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Object Storage_createBucket_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ibee.co.in/v1/object-storage/buckets?workspace_id=710995"

	payload := strings.NewReader("{\n  \"name\": \"production-assets\",\n  \"region\": \"in-south-2\",\n  \"is_public\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Object Storage_createBucket_example
require 'uri'
require 'net/http'

url = URI("https://api.ibee.co.in/v1/object-storage/buckets?workspace_id=710995")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"production-assets\",\n  \"region\": \"in-south-2\",\n  \"is_public\": false\n}"

response = http.request(request)
puts response.read_body
```

```java Object Storage_createBucket_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.ibee.co.in/v1/object-storage/buckets?workspace_id=710995")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"production-assets\",\n  \"region\": \"in-south-2\",\n  \"is_public\": false\n}")
  .asString();
```

```php Object Storage_createBucket_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.ibee.co.in/v1/object-storage/buckets?workspace_id=710995', [
  'body' => '{
  "name": "production-assets",
  "region": "in-south-2",
  "is_public": false
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Object Storage_createBucket_example
using RestSharp;

var client = new RestClient("https://api.ibee.co.in/v1/object-storage/buckets?workspace_id=710995");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"production-assets\",\n  \"region\": \"in-south-2\",\n  \"is_public\": false\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Object Storage_createBucket_example
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "production-assets",
  "region": "in-south-2",
  "is_public": false
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.ibee.co.in/v1/object-storage/buckets?workspace_id=710995")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```