API ReferenceObject Storage

Get bucket

Returns bucket configuration and usage statistics. 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.

Path parameters

bucket_namestringRequired
Logical bucket name.

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.

Response

Bucket returned successfully.
namestring
Unique bucket name within the workspace.
is_publicboolean
Whether the bucket allows unauthenticated read access.
regionstring or null
Object storage region the bucket lives in.
planstring or null
Storage plan billed for the bucket.
statusstring or null
Current bucket status.
site_idstring or null
Identifier of the site holding the bucket. Placement is managed internally.
site_namestring or null

Human-readable name of the site holding the bucket.

bucket_lock_enabledboolean
Whether object lock is enabled on the bucket.
created_atdatetime or null
updated_atdatetime or null
object_countintegerOptional
Number of objects stored in the bucket. Returned by the read and list endpoints only.
total_sizeintegerOptional
Total size in bytes of the objects stored in the bucket. Returned by the read and list endpoints only.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error