Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Update Bucket

PATCH
/storage/v1/workspaces/{workspace}/engines/{engine}/buckets/{id}
 
curl --request PATCH \
  --url https://example.com/storage/v1/workspaces/example/engines/example/buckets/example \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "location_id": "example", "default_storage_class_id": "example", "qibdo": { "versioning_enabled": true } }'

Updates bucket properties (description, versioning, storage class).

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace
required
string

The workspace the bucket belongs to

engine
required
string

The cloud provider: qibdo, aws, gcp, or azure, or ’-’ to target across all providers

id
required
string

The unique identifier of the bucket to update

Query Parameters

Section titled “Query Parameters ”
update_mask
string format: field-mask

The set of fields to update. If omitted, all mutable fields are overwritten. See AIP-134 for field mask semantics.

Request Body required

Section titled “Request Body required ”
Media type application/json

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
id

The unique identifier of the bucket

stringOutput only
workspace_id

The workspace this bucket belongs to

stringOutput only
name
required

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

string
description

An optional human-readable description of the bucket

string
location_id
required

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.

string
default_storage_class_id

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.

string
engine

The cloud provider this bucket is provisioned on.

string format: enum Output only
Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO ENGINE_AWS ENGINE_GCP ENGINE_AZURE
created

Timestamp when the bucket was created

string format: date-time Output only
updated

Timestamp when the bucket was last updated

string format: date-time Output only
qibdo

Attributes specific to a Qibdo-managed bucket.

object
versioning_enabled

Whether object versioning is enabled on this bucket (default false). Kept provider-specific rather than shared at the top level.

boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

StorageOperation tracks the result of a storage command (bucket or object operation).

object
id

Unique operation identifier

stringOutput only
resource_id

The ID of the affected resource (bucket ID; null for object-only ops)

stringOutput only
resource_type

The type of resource (“Bucket” or “Object”)

stringOutput only
operation_type

The operation type (CREATE, UPDATE, DELETE, COPY)

stringOutput only
status

The operation status (PENDING, RUNNING, DONE, ERROR)

stringOutput only
insert_time

When the operation was created

string format: date-time Output only
start_time

When execution started

string format: date-time Output only
end_time

When execution completed

string format: date-time Output only
progress

Progress percentage (0–100)

integer format: int32 Output only
Example generated
{}

default

Section titled “default ”

Default error response

Media type application/json

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
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

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.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}