hosting
POST /v1/storage/buckets
Provision Zinn® storage, or attach a bucket of your own.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز storage.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X POST https://api.zinndigital.com/v1/storage/buckets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی 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