hosting
POST /v1/storage/buckets
Provision Zinn® storage, or attach a bucket of your own.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso storage.manage; una clave que no lo tenga se rechazará con un código 403, no 404.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X POST https://api.zinndigital.com/v1/storage/buckets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
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`.
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
name | string | Sí | — |
ownership | string<zinn, customer> | No | — |
vendor | string<r2, s3, b2, bunny, gcore, minio> | No | — |
bucket_name | string | No | — |
endpoint | string | No | — |
region | string | No | — |
public_base_url | string | No | — |
access_key_id | string | No | Required for `ownership: customer`. Written to Vault, never to a column. |
secret_access_key | string | No | Required for `ownership: customer`. Written to Vault, never to a column. |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
id | string | Sí | — |
name | string | Sí | The customer's own label, not the bucket's name at the vendor. |
ownership | string<zinn, customer> | Sí | `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> | Sí | — |
status | string<pending, active, suspended, failed> | Sí | — |
bucket_name | string | Sí | — |
endpoint | string | No | — |
region | string | No | — |
public_base_url | string | No | 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 | No | — |
objects_stored | integer | No | — |
usage_measured_at | string | No | 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 | Sí | Whether a stored key exists. The key and the Vault path it lives at are deliberately absent from this payload. |
metered | boolean | Sí | Whether this bucket's bytes count against `object_storage_gb`. |
created_at | string | No | — |
Errores que este endpoint puede devolver
401 · 403 · 422 · 429