hosting
POST /v1/storage/buckets
Provision Zinn® storage, or attach a bucket of your own.
認証
ベアラー トークンとして API キーを送信します。キーには storage.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/storage/buckets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
With `ownership: zinn` this provisions storage on our own backend and needs nothing else. With `ownership: customer` it attaches an existing S3-compatible bucket and requires `bucket_name`, `endpoint`, `access_key_id` and `secret_access_key`. The key pair is written to Vault and never to a column; the bucket is created `pending` and only becomes `active` once the write has returned, so a failure part way leaves a visibly unfinished bucket rather than one that reads as configured and cannot sign. Requires `storage.manage`.
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
name | string | はい | — |
ownership | string<zinn, customer> | いいえ | — |
vendor | string<r2, s3, b2, bunny, gcore, minio> | いいえ | — |
bucket_name | string | いいえ | — |
endpoint | string | いいえ | — |
region | string | いいえ | — |
public_base_url | string | いいえ | — |
access_key_id | string | いいえ | Required for `ownership: customer`. Written to Vault, never to a column. |
secret_access_key | string | いいえ | Required for `ownership: customer`. Written to Vault, never to a column. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | string | はい | — |
name | string | はい | The customer's own label, not the bucket's name at the vendor. |
ownership | string<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. |
vendor | string<r2, s3, b2, bunny, gcore, minio> | はい | — |
status | string<pending, active, suspended, failed> | はい | — |
bucket_name | string | はい | — |
endpoint | string | いいえ | — |
region | string | いいえ | — |
public_base_url | string | いいえ | 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 | いいえ | — |
objects_stored | integer | いいえ | — |
usage_measured_at | string | いいえ | 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 | はい | Whether a stored key exists. The key and the Vault path it lives at are deliberately absent from this payload. |
metered | boolean | はい | Whether this bucket's bytes count against `object_storage_gb`. |
created_at | string | いいえ | — |
このエンドポイントが返すエラー
401 · 403 · 422 · 429