Buckets
A set of operations for listing, retrieving, and deleting buckets within your Object Storage account.
| Endpoint Name | URL | Description |
|---|---|---|
| List buckets | GET /object-storage/buckets | Returns a list of your existing buckets. |
| Retrieve bucket | GET /object-storage/buckets/{bucket_name} | Retrieves detailed information about a specific bucket. |
| Delete bucket | DELETE /object-storage/buckets/{bucket_name} | Deletes a bucket and its contents. |
The bucket object
Bucket endpoints return a bucket object, containing metadata about each Object Storage bucket such as name, region, timestamps, and usage statistics.
Attributes of the Bucket object
name string
The name of the bucket.
region string
The region the bucket resides in.
created_at date-time
The ISO 8601 timestamp when the bucket was created.
num_objects integer
Total number of stored objects.
size_bytes integer
Cumulative size of all objects in the bucket, in bytes.
size_bytes_actual integer
Actual space used on disk, including overhead.
Response
{
"name": "my-dataset",
"region": "CANADA-1",
"created_at": "2025-05-22T10:14:31Z",
"num_objects": 12,
"size_bytes": 45789234,
"size_bytes_actual": 45875200
}