hosting

POST /v1/storage/buckets

Provision Zinn® storage, or attach a bucket of your own.

所有 hosting 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 storage.manage 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

curl -X POST https://api.zinndigital.com/v1/storage/buckets \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string> }'

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 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`.

请求正文

名称类型必填内容简介
namestring
ownershipstring<zinn, customer>
vendorstring<r2, s3, b2, bunny, gcore, minio>
bucket_namestring
endpointstring
regionstring
public_base_urlstring
access_key_idstringRequired for `ownership: customer`. Written to Vault, never to a column.
secret_access_keystringRequired for `ownership: customer`. Written to Vault, never to a column.

响应

名称类型必填内容简介
idstring
namestringThe customer's own label, not the bucket's name at the vendor.
ownershipstring<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.
vendorstring<r2, s3, b2, bunny, gcore, minio>
statusstring<pending, active, suspended, failed>
bucket_namestring
endpointstring
regionstring
public_base_urlstringWhere a public object is readable. Empty means the bucket is private and its objects are reachable only through a presigned URL.
bytes_storedinteger
objects_storedinteger
usage_measured_atstringWhen 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_credentialbooleanWhether a stored key exists. The key and the Vault path it lives at are deliberately absent from this payload.
meteredbooleanWhether this bucket's bytes count against `object_storage_gb`.
created_atstring

此端点可能返回的错误

401 · 403 · 422 · 429