hosting

POST `/v1/storage/buckets`

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

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione storage.manage; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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 della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`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.

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`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	—

Errori che questo endpoint può restituire

401 · 403 · 422 · 429

POST /v1/storage/buckets