List buckets

GET

/object-storage/buckets

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

Authentication

AuthorizationBearer

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.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

limitintegerOptional1-1000Defaults to 100

Maximum number of buckets to return.

continuation_tokenstringOptional

Pagination token from the previous response.

Response

Buckets returned successfully.

bucketslist of objectsOptional

is_truncatedbooleanOptional

next_continuation_tokenstring or nullOptional

Errors

401

Unauthorized Error

403

Forbidden Error

1	{
2	"buckets": [
3	{
4	"name": "production-assets",
5	"is_public": false,
6	"region": "in-south-2",
7	"plan": "standard",
8	"status": "active",
9	"site_id": "3",
10	"site_name": "Hyderabad",
11	"bucket_lock_enabled": false,
12	"created_at": "2024-01-15T09:30:00Z",
13	"updated_at": "2024-01-15T09:30:00Z",
14	"object_count": 42,
15	"total_size": 1048576
16	}
17	],
18	"is_truncated": false,
19	"next_continuation_token": "string"
20	}

$	curl -G https://api.ibee.ai/v1/object-storage/buckets \
>	-H "Authorization: Bearer <token>" \
>	-d workspace_id=710995