hosting
POST /v1/storage/buckets
Provision Zinn® storage, or attach a bucket of your own.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění storage.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X POST https://api.zinndigital.com/v1/storage/buckets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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`.
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
name | string | Ano | — |
ownership | string<zinn, customer> | Ne | — |
vendor | string<r2, s3, b2, bunny, gcore, minio> | Ne | — |
bucket_name | string | Ne | — |
endpoint | string | Ne | — |
region | string | Ne | — |
public_base_url | string | Ne | — |
access_key_id | string | Ne | Required for `ownership: customer`. Written to Vault, never to a column. |
secret_access_key | string | Ne | Required for `ownership: customer`. Written to Vault, never to a column. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | string | Ano | — |
name | string | Ano | The customer's own label, not the bucket's name at the vendor. |
ownership | string<zinn, customer> | Ano | `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> | Ano | — |
status | string<pending, active, suspended, failed> | Ano | — |
bucket_name | string | Ano | — |
endpoint | string | Ne | — |
region | string | Ne | — |
public_base_url | string | Ne | 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 | Ne | — |
objects_stored | integer | Ne | — |
usage_measured_at | string | Ne | 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 | Ano | Whether a stored key exists. The key and the Vault path it lives at are deliberately absent from this payload. |
metered | boolean | Ano | Whether this bucket's bytes count against `object_storage_gb`. |
created_at | string | Ne | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 422 · 429