Object Storage

Object Storage usage

get/object-storage/usage

See a month of Object Storage usage: storage, traffic and requests per tier and per bucket, what it cost so far, the free allowance used and a projection for the whole month.

Authorization

Authorization*string

Bearer YOUR_API_TOKEN with an API token. The X-API-Key: YOUR_API_TOKEN header works too.

Query parameters

period?string | null

Month as YYYY-MM (default: the current month)

Rangelength ≤ 7

project_id?integer | null

Only the buckets of this project

tier?string | null

Only this tier (slug or uuid)

Rangelength ≤ 64

tag?array<string>

Only the buckets with this tag now: key or key=value. Repeat it to require several (AND)

Rangeitems ≤ 10

Responses

Successful Response

application/json

period*string

since*string

until*string

metrics_available*boolean

total_cost*number

projected_cost*number

tiers*array<ObjectStorageTierUsage>

Properties (12)

tier*ObjectStorageTierSummary

Properties (4)

uuid*string

slug*string

name*string

media*string

storage_gib_hours?number | null

storage_gib_month?number | null

egress_bytes?integer | null

cdn_bytes?integer | null

class_a_requests?integer | null

class_b_requests?integer | null

class_b_cdn_requests?integer | null

replication_egress_bytes?integer | null

cost*number

projected_cost*number

free_tier*ObjectStorageFreeTierUsage

Properties (3)

storage_gb_month*ObjectStorageFreeTierItem

Properties (2)

included*number

used?number | null

egress_gb*ObjectStorageFreeTierItem

Properties (2)

included*number

used?number | null

requests*ObjectStorageFreeTierItem

Properties (2)

included*number

used?number | null

buckets*array<ObjectStorageBucketUsageRow>

Properties (15)

uuid*string

name*string

status*string

project_id?integer | null

tier_uuid*string

storage_gib_hours?number | null

storage_gib_month?number | null

egress_bytes?integer | null

cdn_bytes?integer | null

class_a_requests?integer | null

class_b_requests?integer | null

class_b_cdn_requests?integer | null

replication_egress_bytes?integer | null

cost*number

tags?record<string, string>

Default{}

available_months*array<string>