認証

ベアラー トークンとして API キーを送信します。キーには storage.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X GET https://api.zinndigital.com/v1/storage/buckets/{bucketId} \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

One bucket belonging to this organisation. Requires storage.view.

パラメータ

名前タイプ必須これがその内容です
bucketId (path)stringはいThe bucket's id.

返信

名前タイプ必須これがその内容です
idstringはい
namestringはいThe customer's own label, not the bucket's name at the vendor.
ownershipstring<zinn, customer>はい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.
vendorstring<r2, s3, b2, bunny, gcore, minio>はい
statusstring<pending, active, suspended, failed>はい
bucket_namestringはい
endpointstringいいえ
regionstringいいえ
public_base_urlstringいいえWhere a public object is readable. Empty means the bucket is private and its objects are reachable only through a presigned URL.
bytes_storedintegerいいえ
objects_storedintegerいいえ
usage_measured_atstringいいえ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_credentialbooleanはいWhether a stored key exists. The key and the Vault path it lives at are deliberately absent from this payload.
meteredbooleanはいWhether this bucket's bytes count against object_storage_gb.
created_atstringいいえ

このエンドポイントが返すエラー

401 · 403 · 404 · 429