hosting

POST `/v1/storage/buckets`

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

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung storage.manage verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

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

Anfragekörper

Name	Typ	Erforderlich	Was es ist
`name`	`string`	Ja	—
`ownership`	`string<zinn, customer>`	Nein	—
`vendor`	`string<r2, s3, b2, bunny, gcore, minio>`	Nein	—
`bucket_name`	`string`	Nein	—
`endpoint`	`string`	Nein	—
`region`	`string`	Nein	—
`public_base_url`	`string`	Nein	—
`access_key_id`	`string`	Nein	Required for `ownership: customer`. Written to Vault, never to a column.
`secret_access_key`	`string`	Nein	Required for `ownership: customer`. Written to Vault, never to a column.

Antwort

Name	Typ	Erforderlich	Was es ist
`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`	Nein	—
`region`	`string`	Nein	—
`public_base_url`	`string`	Nein	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`	Nein	—
`objects_stored`	`integer`	Nein	—
`usage_measured_at`	`string`	Nein	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`	Nein	—

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 422 · 429

POST /v1/storage/buckets