Authentication
Send an API key as a bearer token. The key must carry the storage.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/storage/buckets/{bucketId} \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
One bucket belonging to this organisation. Requires `storage.view`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
bucketId (path) | string | Yes | The bucket's id. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
name | string | Yes | The customer's own label, not the bucket's name at the vendor. |
ownership | string<zinn, customer> | Yes | `zinn` is storage we operate and bill for; `customer` is the organisation's own bucket, which costs us nothing and is not metered against their allowance. |
vendor | string<r2, s3, b2, bunny, gcore, minio> | Yes | — |
status | string<pending, active, suspended, failed> | Yes | — |
bucket_name | string | Yes | — |
endpoint | string | No | — |
region | string | No | — |
public_base_url | string | No | Where a public object is readable. Empty means the bucket is private and its objects are reachable only through a presigned URL. |
bytes_stored | integer | No | — |
objects_stored | integer | No | — |
usage_measured_at | string | No | When the size above was last measured against the vendor. `null` means it has not been measured yet — which is not the same as empty. |
has_credential | boolean | Yes | Whether a stored key exists. The key and the Vault path it lives at are deliberately absent from this payload. |
metered | boolean | Yes | Whether this bucket's bytes count against `object_storage_gb`. |
created_at | string | No | — |
Errors this endpoint can return
401 · 403 · 404 · 429