hosting

POST `/v1/storage/buckets`

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

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (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

التفاصيل

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