hosting
POST /v1/storage/buckets
Provision Zinn® storage, or attach a bucket of your own.
Pengesahan
Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran storage.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X POST https://api.zinndigital.com/v1/storage/buckets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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`.
Badan permintaan
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
name | string | Ya | — |
ownership | string<zinn, customer> | Tidak | — |
vendor | string<r2, s3, b2, bunny, gcore, minio> | Tidak | — |
bucket_name | string | Tidak | — |
endpoint | string | Tidak | — |
region | string | Tidak | — |
public_base_url | string | Tidak | — |
access_key_id | string | Tidak | Required for `ownership: customer`. Written to Vault, never to a column. |
secret_access_key | string | Tidak | Required for `ownership: customer`. Written to Vault, never to a column. |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
id | string | Ya | — |
name | string | Ya | The customer's own label, not the bucket's name at the vendor. |
ownership | string<zinn, customer> | Ya | `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> | Ya | — |
status | string<pending, active, suspended, failed> | Ya | — |
bucket_name | string | Ya | — |
endpoint | string | Tidak | — |
region | string | Tidak | — |
public_base_url | string | Tidak | 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 | Tidak | — |
objects_stored | integer | Tidak | — |
usage_measured_at | string | Tidak | 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 | Ya | Whether a stored key exists. The key and the Vault path it lives at are deliberately absent from this payload. |
metered | boolean | Ya | Whether this bucket's bytes count against `object_storage_gb`. |
created_at | string | Tidak | — |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 422 · 429