hosting

POST `/v1/storage/buckets`

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

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה 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 הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-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`	לא	—

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 422 · 429

POST /v1/storage/buckets