hosting

POST `/v1/storage/buckets`

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

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão storage.manage; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`name`	`string`	Sim	—
`ownership`	`string<zinn, customer>`	Não	—
`vendor`	`string<r2, s3, b2, bunny, gcore, minio>`	Não	—
`bucket_name`	`string`	Não	—
`endpoint`	`string`	Não	—
`region`	`string`	Não	—
`public_base_url`	`string`	Não	—
`access_key_id`	`string`	Não	Required for `ownership: customer`. Written to Vault, never to a column.
`secret_access_key`	`string`	Não	Required for `ownership: customer`. Written to Vault, never to a column.

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`string`	Sim	—
`name`	`string`	Sim	The customer's own label, not the bucket's name at the vendor.
`ownership`	`string<zinn, customer>`	Sim	`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>`	Sim	—
`status`	`string<pending, active, suspended, failed>`	Sim	—
`bucket_name`	`string`	Sim	—
`endpoint`	`string`	Não	—
`region`	`string`	Não	—
`public_base_url`	`string`	Não	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`	Não	—
`objects_stored`	`integer`	Não	—
`usage_measured_at`	`string`	Não	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`	Sim	Whether a stored key exists. The key and the Vault path it lives at are deliberately absent from this payload.
`metered`	`boolean`	Sim	Whether this bucket's bytes count against `object_storage_gb`.
`created_at`	`string`	Não	—

Erros que este endpoint pode retornar

401 · 403 · 422 · 429

POST /v1/storage/buckets