hosting

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

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

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग 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