> 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.

# List buckets

GET https://api.ibee.co.in/v1/object-storage/buckets

Lists object storage buckets in a workspace. Requires scope: object-storage.read.

Reference: https://docs.ibee.co.in/docs/api-reference/object-storage/list-buckets

## 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.
- `limit` (integer, optional, default: 100) — Maximum number of buckets to return.
- `continuation_token` (string, optional) — Pagination token from the previous response.

## Response

### 200

Buckets returned successfully.

- `buckets` (list of Bucket, optional)
- `is_truncated` (boolean, optional)
- `next_continuation_token` (string, optional, nullable)

## Errors

### 401 Unauthorized Error

The API token is missing or invalid.

- `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

### Bucket

An object storage bucket. Read and list responses carry the usage counters `object_count` and `total_size`; the create response omits them because usage is only measured once the bucket exists.

- `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.

### ErrorDetail

## Examples

**Response**

```json
{
  "buckets": [
    {
      "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
    }
  ],
  "is_truncated": false,
  "next_continuation_token": "string"
}
```

**SDK Code**

```python
import requests

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

querystring = {"workspace_id":"710995"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.ibee.co.in/v1/object-storage/buckets?workspace_id=710995';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

```go
package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

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

}
```

```ruby
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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

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

HttpResponse<String> response = Unirest.get("https://api.ibee.co.in/v1/object-storage/buckets?workspace_id=710995")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.ibee.co.in/v1/object-storage/buckets?workspace_id=710995', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.ibee.co.in/v1/object-storage/buckets?workspace_id=710995");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

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 = "GET"
request.allHTTPHeaderFields = headers

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()
```