Object Storage
Get bucket
get
/object-storage/buckets/{bucket_uuid}See one bucket in detail: how to connect to it with any S3 client, this month's storage, traffic, requests and cost, and its CDN connection.
Authorization
Authorization
Authorization*string
Bearer YOUR_API_TOKEN with an API token. The X-API-Key: YOUR_API_TOKEN header works too.
Path parameters
bucket_uuid*string
Responses
Successful Response
application/json
uuid*string
name*string
status*string
suspend_reason?string | null
write_blocked?boolean
Default
falseerror_message?string | null
project_id?integer | null
tier*ObjectStorageTierSummary
Properties (4)
uuid*string
slug*string
name*string
media*string
location_name?string | null
region*string
endpoint*string
versioning*string
protected*boolean
size_bytes*integer
size_cap_gb_effective*integer
objects_count*integer
usage_updated_at?string | null
monthly_charges*number
cdn_connected*boolean
tags?record<string, string>
Default
{}lifecycle_status?string
Default
"none"lifecycle_rules_count?integer
Default
0event_rules_count?integer
Default
0object_lock*ObjectStorageObjectLockOut
Properties (2)
enabled*boolean
default_retention?ObjectStorageLockRetentionOut | null
Properties (3)
mode*string
Value in
"governance""compliance"days?integer | null
years?integer | null
locked_content_kept?boolean
Default
falseencryption?ObjectStorageBucketEncryptionOut | null
Encryption at rest (SSE-S3). scope: all_objects, or new_objects while objects written
before the bucket default may still be stored in plaintext.
Properties (3)
algorithm*string
Value in
"AES256"scope*string
Value in
"all_objects""new_objects"applied_at?string | null
When the bucket's encryption default was applied
Format
date-timeactive_at?string | null
last_billed_time?string | null
connection*ObjectStorageConnection
Properties (4)
endpoint*string
region*string
path_style_url*string
virtual_host_url*string
usage?ObjectStorageBucketUsage | null
Properties (10)
period*string
since*string
until*string
storage_gib_hours*number
storage_gib_month*number
egress_bytes*integer
cdn_bytes*integer
class_a_requests*integer
class_b_requests*integer
class_b_cdn_requests*integer
cdn?ObjectStorageBucketCdn | null
Properties (8)
status*string
Value in
"connecting""connected""disconnecting""error""disconnected"zone_uuid*string
zone_name*string
domain*string
custom_domain?string | null
zone_status*string
origin_uuid*string
origin_enabled*boolean
replication?ObjectStorageBucketReplicationOut | null
Properties (2)
outgoing?ObjectStorageReplicationOut | null
Properties (14)
uuid*string
status*string
pause_reason?string | null
direction*string
Value in
"outgoing""incoming"source*ObjectStorageReplicationSourceOut
Properties (5)
bucket_uuid?string | null
bucket_name?string | null
project_id?integer | null
organization_name?string | null
same_organization*boolean
destination*ObjectStorageReplicationCubepathDestOut | ObjectStorageReplicationExternalDestOut
One of
ObjectStorageReplicationCubepathDestOut
Properties (6)
type*string
Value in
"cubepath"bucket_uuid?string | null
bucket_name?string | null
project_id?integer | null
organization_name?string | null
same_organization*boolean
ObjectStorageReplicationExternalDestOut
Properties (7)
type*string
Value in
"external"provider?string | null
endpoint?string | null
region?string | null
bucket?string | null
path_style*string
access_key_id?string | null
Masked: **** and the last 4 characters
rules*ObjectStorageReplicationRulesOut
Properties (6)
enabled*boolean
prefix?string | null
tags?array<ObjectStorageLifecycleTagOut>
Properties (2)
key*string
value*string
delete_marker_replication*boolean
delete_replication*boolean
existing_objects*boolean
health*string
health_reason?string | null
health_checked_at?string | null
backfill*ObjectStorageReplicationBackfillOut
Properties (6)
status*string
started_at?string | null
finished_at?string | null
objects*integer
bytes*integer
failed_objects*integer
error_message?string | null
created_at?string | null
active_at?string | null
incoming_count?integer
Default
0