hosting

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

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

Ìfàṣẹ́pọ̀

Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda storage.manage; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.

Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

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

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn kúlẹ̀kúlẹ̀

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`.

Àwọn ìpìlẹ̀

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`siteId (path)`	`Uuid`	Bẹẹni	Site ID (UUIDv7).

Akoonu ibeere naa

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`bucket_id`	`string`	Bẹẹkọ	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`	Bẹẹkọ	Pause or resume a paired site. Ignored before the plugin has paired.
`rewrite_urls`	`boolean`	Bẹẹkọ	—
`delete_local`	`boolean`	Bẹẹkọ	—
`prefix`	`string`	Bẹẹkọ	—
`custom_domain`	`string`	Bẹẹkọ	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…

Idahun

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`configured`	`boolean`	Bẹẹni	`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`	Bẹẹkọ	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`	Bẹẹkọ	—
`site_id`	`string`	Bẹẹkọ	—
`bucket_id`	`string`	Bẹẹkọ	—
`status`	`string<awaiting_pairing, active, paused, revoked>`	Bẹẹkọ	—
`prefix`	`string`	Bẹẹkọ	The key prefix this site's objects live under.
`rewrite_urls`	`boolean`	Bẹẹkọ	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`	Bẹẹkọ	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`	Bẹẹkọ	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`	Bẹẹkọ	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`	Bẹẹkọ	`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`	Bẹẹkọ	Whether the plugin may currently upload. Requires both an active offload and a usable bucket.
`paired`	`boolean`	Bẹẹkọ	Whether a plugin token has been issued. The token and its hash are never returned.
`plugin_version`	`string`	Bẹẹkọ	—
`last_seen_at`	`string`	Bẹẹkọ	When the plugin last called. `null` means it never has.
`objects_offloaded`	`integer`	Bẹẹkọ	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`	Bẹẹkọ	—
`created_at`	`string`	Bẹẹkọ	—

Awọn aṣiṣe ti ibudo ipari yii le da pada

401 · 403 · 404 · 422 · 429

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