hosting

PUT `/v1/sites/{siteId}/media-offload`

Turn media offload on for a site, or change how it behaves.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن storage.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/media-offload \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

Creates the offload configuration if it does not exist, provisioning storage for the organisation on first use — "turn on media offload" is what the customer wants, and a bucket is our word for part of how we do it. Moving an offload that is already live to a **different** bucket answers `422`. The objects already written stay where they are, so the switch would leave the site serving half its media from a bucket the configuration no longer names, and nothing would report it because new uploads would keep succeeding. Requires `storage.manage`.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`siteId (path)`	`Uuid`	نعم	Site ID (UUIDv7).

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`bucket_id`	`string`	لا	Which bucket to use. Omit to use the organisation's own, provisioning one on first use. Changing this on a live offload is refused.
`enabled`	`boolean`	لا	Pause or resume a paired site. Ignored before the plugin has paired.
`rewrite_urls`	`boolean`	لا	—
`delete_local`	`boolean`	لا	—
`prefix`	`string`	لا	—
`custom_domain`	`string`	لا	A media domain of the site's own, replacing the shared Zinn® hostname. Must be `https://` and a bare domain with no path. Send `""` to clear it. Required to turn on URL rewritin…

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`configured`	`boolean`	نعم	`false` when this site has no offload set up. The rest of the fields are then absent. A site with no offload is a `200`, never a `404`.
`id`	`string`	لا	—
`site_id`	`string`	لا	—
`bucket_id`	`string`	لا	—
`status`	`string<awaiting_pairing, active, paused, revoked>`	لا	—
`prefix`	`string`	لا	The key prefix this site's objects live under.
`rewrite_urls`	`boolean`	لا	Whether the plugin points media URLs at the bucket. Off means "upload a copy but keep serving locally", which is how a cautious customer migrates.
`delete_local`	`boolean`	لا	Whether the plugin removes the local file after a confirmed upload. Defaults to off, and even when on the plugin refuses to delete after a partial upload.
`custom_domain`	`string`	لا	The site's OWN media domain, as the customer typed it, or `""`. This is what belongs in the settings input box. See `public_base_url` for where media is actually served from — t…
`public_base_url`	`string`	لا	Where this site's media is actually served from, after the site's own domain, the footprint rule and the bucket's shared hostname have been resolved. `""` means no URL is rewrit…
`needs_custom_domain`	`boolean`	لا	`true` when this site is serving media locally only because it has no media domain of its own — a footprint-free site awaiting a CNAME. Distinguishes the one empty-`public_base_…
`accepts_uploads`	`boolean`	لا	Whether the plugin may currently upload. Requires both an active offload and a usable bucket.
`paired`	`boolean`	لا	Whether a plugin token has been issued. The token and its hash are never returned.
`plugin_version`	`string`	لا	—
`last_seen_at`	`string`	لا	When the plugin last called. `null` means it never has.
`objects_offloaded`	`integer`	لا	What the plugin reports it has moved. A diagnostic for the screen, never an input to billing — storage is metered by measuring the bucket.
`bytes_offloaded`	`integer`	لا	—
`created_at`	`string`	لا	—

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 422 · 429

PUT /v1/sites/{siteId}/media-offload