List Buckets
const url = 'https://example.com/storage/v1/workspaces/example/engines/example/buckets';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/storage/v1/workspaces/example/engines/example/bucketsReturns a paginated list of buckets within a workspace. A specific provider filters to that
provider; - lists buckets across all providers.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The workspace to list buckets for
The cloud provider: qibdo, aws, gcp, or azure, or ’-’ to list across all providers
Query Parameters
Section titled “Query Parameters ”The maximum number of buckets to return. The service may return fewer than this value. If unspecified, at most 20 buckets will be returned. The maximum value is 100; values above 100 will be coerced to 100.
A page token, received from a previous ListBuckets call. Provide this to retrieve the
subsequent page. When paginating, all other parameters must match the call that provided
the page token.
AIP-160 filter expression
AIP-132 order_by expression, e.g. ‘name asc’
Responses
Section titled “ Responses ”OK
ListBucketsResponse
Response message for ListBuckets.
Note: This API intentionally omits total_size from list responses. Keyset pagination does
not support efficient total count computation (COUNT(*) requires a full table scan). Per
AIP-158, total_size is optional.
object
The list of buckets
A bucket is a workspace-scoped container that holds a set of stored objects.
Buckets can be provisioned across different cloud providers; the provider a bucket
lives on is reported by the read-only engine field.
object
The unique identifier of the bucket
The workspace this bucket belongs to
The bucket name (3–26 chars, lowercase alphanumeric and hyphens only). Must match ^[a-z0-9][a-z0-9-]{1,24}[a-z0-9]$ — the 26-char limit derives from the 63-char S3 bucket name limit minus the 37-char {workspaceId}- prefix (UUID = 36 chars + separator).
An optional human-readable description of the bucket
Weak reference to a topology Location — the region where the bucket’s data resides. A shared concept across providers, so it lives at the top level rather than in a provider-specific arm.
Weak reference to storage.storage_classes — the default storage class for objects in this bucket. Optional; when omitted the bucket inherits the global default tier.
The cloud provider this bucket is provisioned on.
Timestamp when the bucket was created
Timestamp when the bucket was last updated
Attributes specific to a Qibdo-managed bucket.
object
Whether object versioning is enabled on this bucket (default false). Kept provider-specific rather than shared at the top level.
A token, which can be sent as page_token to retrieve the next page. If this field is
empty, there are no subsequent pages.
Example
{ "buckets": [ { "engine": "ENGINE_UNSPECIFIED" } ]}default
Section titled “default ”Default error response
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}