hosting

POST `/v1/storage/buckets`

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

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie storage.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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`.

Aanvraaglichaam

Naam	Type	Verplicht	Wat dit is
`name`	`string`	Ja	—
`ownership`	`string<zinn, customer>`	Nee	—
`vendor`	`string<r2, s3, b2, bunny, gcore, minio>`	Nee	—
`bucket_name`	`string`	Nee	—
`endpoint`	`string`	Nee	—
`region`	`string`	Nee	—
`public_base_url`	`string`	Nee	—
`access_key_id`	`string`	Nee	Required for `ownership: customer`. Written to Vault, never to a column.
`secret_access_key`	`string`	Nee	Required for `ownership: customer`. Written to Vault, never to a column.

Reactie

Naam	Type	Verplicht	Wat dit is
`id`	`string`	Ja	—
`name`	`string`	Ja	The customer's own label, not the bucket's name at the vendor.
`ownership`	`string<zinn, customer>`	Ja	`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>`	Ja	—
`status`	`string<pending, active, suspended, failed>`	Ja	—
`bucket_name`	`string`	Ja	—
`endpoint`	`string`	Nee	—
`region`	`string`	Nee	—
`public_base_url`	`string`	Nee	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`	Nee	—
`objects_stored`	`integer`	Nee	—
`usage_measured_at`	`string`	Nee	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`	Ja	Whether a stored key exists. The key and the Vault path it lives at are deliberately absent from this payload.
`metered`	`boolean`	Ja	Whether this bucket's bytes count against `object_storage_gb`.
`created_at`	`string`	Nee	—

Fouten die dit eindpunt kan retourneren

401 · 403 · 422 · 429

POST /v1/storage/buckets