hosting
POST /v1/storage/buckets
Provision Zinn® storage, or attach a bucket of your own.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл 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