hosting
POST /v1/storage/buckets
Provision Zinn® storage, or attach a bucket of your own.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) storage.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X POST https://api.zinndigital.com/v1/storage/buckets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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`.
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
name | string | Igen | — |
ownership | string<zinn, customer> | Nem | — |
vendor | string<r2, s3, b2, bunny, gcore, minio> | Nem | — |
bucket_name | string | Nem | — |
endpoint | string | Nem | — |
region | string | Nem | — |
public_base_url | string | Nem | — |
access_key_id | string | Nem | Required for `ownership: customer`. Written to Vault, never to a column. |
secret_access_key | string | Nem | Required for `ownership: customer`. Written to Vault, never to a column. |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | string | Igen | — |
name | string | Igen | The customer's own label, not the bucket's name at the vendor. |
ownership | string<zinn, customer> | Igen | `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> | Igen | — |
status | string<pending, active, suspended, failed> | Igen | — |
bucket_name | string | Igen | — |
endpoint | string | Nem | — |
region | string | Nem | — |
public_base_url | string | Nem | 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 | Nem | — |
objects_stored | integer | Nem | — |
usage_measured_at | string | Nem | 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 | Igen | Whether a stored key exists. The key and the Vault path it lives at are deliberately absent from this payload. |
metered | boolean | Igen | Whether this bucket's bytes count against `object_storage_gb`. |
created_at | string | Nem | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 422 · 429