hosting
POST /v1/storage/buckets
Provision Zinn® storage, or attach a bucket of your own.
توثيقِ شناخت
ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس storage.manage اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔
یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔
آزمائیں
کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔
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