hosting

POST `/v1/storage/buckets`

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

Authentication

Send an API key as a bearer token. The key must carry the storage.manage permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

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`.

Request body

Name	Type	Required	What it is
`name`	`string`	Yes	—
`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.

Response

Name	Type	Required	What it is
`id`	`string`	Yes	—
`name`	`string`	Yes	The customer's own label, not the bucket's name at the vendor.
`ownership`	`string<zinn, customer>`	Yes	`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>`	Yes	—
`status`	`string<pending, active, suspended, failed>`	Yes	—
`bucket_name`	`string`	Yes	—
`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`	Yes	Whether a stored key exists. The key and the Vault path it lives at are deliberately absent from this payload.
`metered`	`boolean`	Yes	Whether this bucket's bytes count against `object_storage_gb`.
`created_at`	`string`	No	—

Errors this endpoint can return

401 · 403 · 422 · 429

POST /v1/storage/buckets