hosting

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

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

توثيقِ شناخت

ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس storage.manage اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

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

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو 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 — except `plan`, which is present in both states on purpose.
`plan`	`MediaStorageTerms`	نہیں	What this site's organisation gets included for media storage, what it is using, and what more would cost. Present on every media-offload response, including `configured: fa…
`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