Skip to navigation

List buckets

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

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
curl "https://api.ibee.ai/v1/object-storage/buckets?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

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
Buckets on this page.
is_truncatedbooleanOptional
True when more buckets exist beyond this page.
next_continuation_tokenstring or nullOptional

Token to pass as continuation_token to fetch the next page; null on the last page.

Errors

401
Unauthorized Error
403
Forbidden Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error