hosting

POST `/v1/storage/buckets`

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

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението storage.manage; ключ без него се отхвърля с 403, а не с 404.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

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

Тяло на заявката

Име	Тип	Задължително	Какво представлява
`name`	`string`	Да	—
`ownership`	`string<zinn, customer>`	Не	—
`vendor`	`string<r2, s3, b2, bunny, gcore, minio>`	Не	—
`bucket_name`	`string`	Не	—
`endpoint`	`string`	Не	—
`region`	`string`	Не	—
`public_base_url`	`string`	Не	—
`access_key_id`	`string`	Не	Required for `ownership: customer`. Written to Vault, never to a column.
`secret_access_key`	`string`	Не	Required for `ownership: customer`. Written to Vault, never to a column.

Отговор

Име	Тип	Задължително	Какво представлява
`id`	`string`	Да	—
`name`	`string`	Да	The customer's own label, not the bucket's name at the vendor.
`ownership`	`string<zinn, customer>`	Да	`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>`	Да	—
`status`	`string<pending, active, suspended, failed>`	Да	—
`bucket_name`	`string`	Да	—
`endpoint`	`string`	Не	—
`region`	`string`	Не	—
`public_base_url`	`string`	Не	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`	Не	—
`objects_stored`	`integer`	Не	—
`usage_measured_at`	`string`	Не	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`	Да	Whether a stored key exists. The key and the Vault path it lives at are deliberately absent from this payload.
`metered`	`boolean`	Да	Whether this bucket's bytes count against `object_storage_gb`.
`created_at`	`string`	Не	—

Грешки, които този крайpoint може да върне

401 · 403 · 422 · 429

POST /v1/storage/buckets